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

ibm.getEnDestinationCustomSms

Explore with Pulumi AI

Provides a read-only data source for Custom SMS destination. 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 customSmsEnDestination = ibm.getEnDestinationCustomSms({
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    destinationId: ibm_en_destination_custom_sms.destination1.destination_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

custom_sms_en_destination = ibm.get_en_destination_custom_sms(instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    destination_id=ibm_en_destination_custom_sms["destination1"]["destination_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.LookupEnDestinationCustomSms(ctx, &ibm.LookupEnDestinationCustomSmsArgs{
			InstanceGuid:  ibm_resource_instance.En_terraform_test_resource.Guid,
			DestinationId: ibm_en_destination_custom_sms.Destination1.Destination_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 customSmsEnDestination = Ibm.GetEnDestinationCustomSms.Invoke(new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        DestinationId = ibm_en_destination_custom_sms.Destination1.Destination_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.GetEnDestinationCustomSmsArgs;
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 customSmsEnDestination = IbmFunctions.getEnDestinationCustomSms(GetEnDestinationCustomSmsArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .destinationId(ibm_en_destination_custom_sms.destination1().destination_id())
            .build());

    }
}
Copy
variables:
  customSmsEnDestination:
    fn::invoke:
      function: ibm:getEnDestinationCustomSms
      arguments:
        instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
        destinationId: ${ibm_en_destination_custom_sms.destination1.destination_id}
Copy

Using getEnDestinationCustomSms

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 getEnDestinationCustomSms(args: GetEnDestinationCustomSmsArgs, opts?: InvokeOptions): Promise<GetEnDestinationCustomSmsResult>
function getEnDestinationCustomSmsOutput(args: GetEnDestinationCustomSmsOutputArgs, opts?: InvokeOptions): Output<GetEnDestinationCustomSmsResult>
Copy
def get_en_destination_custom_sms(destination_id: Optional[str] = None,
                                  id: Optional[str] = None,
                                  instance_guid: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetEnDestinationCustomSmsResult
def get_en_destination_custom_sms_output(destination_id: Optional[pulumi.Input[str]] = None,
                                  id: Optional[pulumi.Input[str]] = None,
                                  instance_guid: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetEnDestinationCustomSmsResult]
Copy
func LookupEnDestinationCustomSms(ctx *Context, args *LookupEnDestinationCustomSmsArgs, opts ...InvokeOption) (*LookupEnDestinationCustomSmsResult, error)
func LookupEnDestinationCustomSmsOutput(ctx *Context, args *LookupEnDestinationCustomSmsOutputArgs, opts ...InvokeOption) LookupEnDestinationCustomSmsResultOutput
Copy

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

public static class GetEnDestinationCustomSms 
{
    public static Task<GetEnDestinationCustomSmsResult> InvokeAsync(GetEnDestinationCustomSmsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnDestinationCustomSmsResult> Invoke(GetEnDestinationCustomSmsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnDestinationCustomSmsResult> getEnDestinationCustomSms(GetEnDestinationCustomSmsArgs args, InvokeOptions options)
public static Output<GetEnDestinationCustomSmsResult> getEnDestinationCustomSms(GetEnDestinationCustomSmsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getEnDestinationCustomSms:getEnDestinationCustomSms
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DestinationId This property is required. string
Unique identifier for Destination.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Id string
The unique identifier of the custom_sms_en_destination.
DestinationId This property is required. string
Unique identifier for Destination.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Id string
The unique identifier of the custom_sms_en_destination.
destinationId This property is required. String
Unique identifier for Destination.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
id String
The unique identifier of the custom_sms_en_destination.
destinationId This property is required. string
Unique identifier for Destination.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
id string
The unique identifier of the custom_sms_en_destination.
destination_id This property is required. str
Unique identifier for Destination.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
id str
The unique identifier of the custom_sms_en_destination.
destinationId This property is required. String
Unique identifier for Destination.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
id String
The unique identifier of the custom_sms_en_destination.

getEnDestinationCustomSms Result

The following output properties are available:

CollectFailedEvents bool
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Description string
(String) Destination description.
DestinationId string
Id string
The unique identifier of the custom_sms_en_destination.
InstanceGuid string
Name string
(String) Destination name.
SubscriptionCount double
(Integer) Number of subscriptions.
SubscriptionNames List<string>
(List) List of subscriptions.
Type string
(String) Destination type smtp_custom.
UpdatedAt string
(String) Last updated time.
CollectFailedEvents bool
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Description string
(String) Destination description.
DestinationId string
Id string
The unique identifier of the custom_sms_en_destination.
InstanceGuid string
Name string
(String) Destination name.
SubscriptionCount float64
(Integer) Number of subscriptions.
SubscriptionNames []string
(List) List of subscriptions.
Type string
(String) Destination type smtp_custom.
UpdatedAt string
(String) Last updated time.
collectFailedEvents Boolean
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
description String
(String) Destination description.
destinationId String
id String
The unique identifier of the custom_sms_en_destination.
instanceGuid String
name String
(String) Destination name.
subscriptionCount Double
(Integer) Number of subscriptions.
subscriptionNames List<String>
(List) List of subscriptions.
type String
(String) Destination type smtp_custom.
updatedAt String
(String) Last updated time.
collectFailedEvents boolean
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
description string
(String) Destination description.
destinationId string
id string
The unique identifier of the custom_sms_en_destination.
instanceGuid string
name string
(String) Destination name.
subscriptionCount number
(Integer) Number of subscriptions.
subscriptionNames string[]
(List) List of subscriptions.
type string
(String) Destination type smtp_custom.
updatedAt string
(String) Last updated time.
collect_failed_events bool
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
description str
(String) Destination description.
destination_id str
id str
The unique identifier of the custom_sms_en_destination.
instance_guid str
name str
(String) Destination name.
subscription_count float
(Integer) Number of subscriptions.
subscription_names Sequence[str]
(List) List of subscriptions.
type str
(String) Destination type smtp_custom.
updated_at str
(String) Last updated time.
collectFailedEvents Boolean
(boolean) Toggle switch to enable collect failed event in Cloud Object Storage bucket.
description String
(String) Destination description.
destinationId String
id String
The unique identifier of the custom_sms_en_destination.
instanceGuid String
name String
(String) Destination name.
subscriptionCount Number
(Integer) Number of subscriptions.
subscriptionNames List<String>
(List) List of subscriptions.
type String
(String) Destination type smtp_custom.
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.