Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. EnDestinationCustomSms
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.EnDestinationCustomSms

Explore with Pulumi AI

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

    Create, update, or delete a Custom SMS destination by using IBM Cloud™ Event Notifications.

    Example Usage

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

const customSmsEnDestination = new ibm.EnDestinationCustomSms("customSmsEnDestination", {
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    type: "sms_custom",
    collectFailedEvents: true,
    description: "Destination Custom SMS for event notification",
});

    import pulumi
import pulumi_ibm as ibm

custom_sms_en_destination = ibm.EnDestinationCustomSms("customSmsEnDestination",
    instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    type="sms_custom",
    collect_failed_events=True,
    description="Destination Custom SMS for event notification")

    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.NewEnDestinationCustomSms(ctx, "customSmsEnDestination", &ibm.EnDestinationCustomSmsArgs{
			InstanceGuid:        pulumi.Any(ibm_resource_instance.En_terraform_test_resource.Guid),
			Type:                pulumi.String("sms_custom"),
			CollectFailedEvents: pulumi.Bool(true),
			Description:         pulumi.String("Destination Custom SMS for event notification"),
		})
		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 customSmsEnDestination = new Ibm.EnDestinationCustomSms("customSmsEnDestination", new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        Type = "sms_custom",
        CollectFailedEvents = true,
        Description = "Destination Custom SMS for event notification",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnDestinationCustomSms;
import com.pulumi.ibm.EnDestinationCustomSmsArgs;
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) {
        var customSmsEnDestination = new EnDestinationCustomSms("customSmsEnDestination", EnDestinationCustomSmsArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .type("sms_custom")
            .collectFailedEvents(true)
            .description("Destination Custom SMS for event notification")
            .build());

    }
}

    resources:
  customSmsEnDestination:
    type: ibm:EnDestinationCustomSms
    properties:
      instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
      type: sms_custom
      collectFailedEvents: true
      description: Destination Custom SMS for event notification

    Create EnDestinationCustomSms Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EnDestinationCustomSms(name: string, args: EnDestinationCustomSmsArgs, opts?: CustomResourceOptions);
    @overload
def EnDestinationCustomSms(resource_name: str,
                           args: EnDestinationCustomSmsArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def EnDestinationCustomSms(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           instance_guid: Optional[str] = None,
                           type: Optional[str] = None,
                           collect_failed_events: Optional[bool] = None,
                           description: Optional[str] = None,
                           en_destination_custom_sms_id: Optional[str] = None,
                           name: Optional[str] = None)
    func NewEnDestinationCustomSms(ctx *Context, name string, args EnDestinationCustomSmsArgs, opts ...ResourceOption) (*EnDestinationCustomSms, error)
    public EnDestinationCustomSms(string name, EnDestinationCustomSmsArgs args, CustomResourceOptions? opts = null)
    public EnDestinationCustomSms(String name, EnDestinationCustomSmsArgs args)
public EnDestinationCustomSms(String name, EnDestinationCustomSmsArgs args, CustomResourceOptions options)

    type: ibm:EnDestinationCustomSms
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EnDestinationCustomSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnDestinationCustomSmsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnDestinationCustomSmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnDestinationCustomSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnDestinationCustomSmsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var enDestinationCustomSmsResource = new Ibm.EnDestinationCustomSms("enDestinationCustomSmsResource", new()
{
    InstanceGuid = "string",
    Type = "string",
    CollectFailedEvents = false,
    Description = "string",
    EnDestinationCustomSmsId = "string",
    Name = "string",
});

    example, err := ibm.NewEnDestinationCustomSms(ctx, "enDestinationCustomSmsResource", &ibm.EnDestinationCustomSmsArgs{
	InstanceGuid:             pulumi.String("string"),
	Type:                     pulumi.String("string"),
	CollectFailedEvents:      pulumi.Bool(false),
	Description:              pulumi.String("string"),
	EnDestinationCustomSmsId: pulumi.String("string"),
	Name:                     pulumi.String("string"),
})

    var enDestinationCustomSmsResource = new EnDestinationCustomSms("enDestinationCustomSmsResource", EnDestinationCustomSmsArgs.builder()
    .instanceGuid("string")
    .type("string")
    .collectFailedEvents(false)
    .description("string")
    .enDestinationCustomSmsId("string")
    .name("string")
    .build());

    en_destination_custom_sms_resource = ibm.EnDestinationCustomSms("enDestinationCustomSmsResource",
    instance_guid="string",
    type="string",
    collect_failed_events=False,
    description="string",
    en_destination_custom_sms_id="string",
    name="string")

    const enDestinationCustomSmsResource = new ibm.EnDestinationCustomSms("enDestinationCustomSmsResource", {
    instanceGuid: "string",
    type: "string",
    collectFailedEvents: false,
    description: "string",
    enDestinationCustomSmsId: "string",
    name: "string",
});

    type: ibm:EnDestinationCustomSms
properties:
    collectFailedEvents: false
    description: string
    enDestinationCustomSmsId: string
    instanceGuid: string
    name: string
    type: string

    EnDestinationCustomSms Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EnDestinationCustomSms resource accepts the following input properties:

    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    sms_custom.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Description string
    The Destination description.
    EnDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    Name string
    The Destintion name.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    sms_custom.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Description string
    The Destination description.
    EnDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    Name string
    The Destintion name.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    sms_custom.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description String
    The Destination description.
    enDestinationCustomSmsId String
    (String) The unique identifier of the custom_sms_en_destination.
    name String
    The Destintion name.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    type string
    sms_custom.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description string
    The Destination description.
    enDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    name string
    The Destintion name.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    type str
    sms_custom.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description str
    The Destination description.
    en_destination_custom_sms_id str
    (String) The unique identifier of the custom_sms_en_destination.
    name str
    The Destintion name.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    sms_custom.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description String
    The Destination description.
    enDestinationCustomSmsId String
    (String) The unique identifier of the custom_sms_en_destination.
    name String
    The Destintion name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EnDestinationCustomSms resource produces the following output properties:

    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.
    destinationId string
    (String) The unique identifier of the created destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    updatedAt string
    (String) Last updated time.
    destination_id str
    (String) The unique identifier of the created destination.
    id str
    The provider-assigned unique ID for this managed resource.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    updated_at str
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnDestinationCustomSms Resource

    Get an existing EnDestinationCustomSms resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EnDestinationCustomSmsState, opts?: CustomResourceOptions): EnDestinationCustomSms
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collect_failed_events: Optional[bool] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        en_destination_custom_sms_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        name: Optional[str] = None,
        subscription_count: Optional[float] = None,
        subscription_names: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> EnDestinationCustomSms
    func GetEnDestinationCustomSms(ctx *Context, name string, id IDInput, state *EnDestinationCustomSmsState, opts ...ResourceOption) (*EnDestinationCustomSms, error)
    public static EnDestinationCustomSms Get(string name, Input<string> id, EnDestinationCustomSmsState? state, CustomResourceOptions? opts = null)
    public static EnDestinationCustomSms get(String name, Output<String> id, EnDestinationCustomSmsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnDestinationCustomSms    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    The Destintion name.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    Type string
    sms_custom.
    UpdatedAt string
    (String) Last updated time.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    The Destintion name.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    Type string
    sms_custom.
    UpdatedAt string
    (String) Last updated time.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationCustomSmsId String
    (String) The unique identifier of the custom_sms_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    The Destintion name.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    sms_custom.
    updatedAt String
    (String) Last updated time.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description string
    The Destination description.
    destinationId string
    (String) The unique identifier of the created destination.
    enDestinationCustomSmsId string
    (String) The unique identifier of the custom_sms_en_destination.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    The Destintion name.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    type string
    sms_custom.
    updatedAt string
    (String) Last updated time.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description str
    The Destination description.
    destination_id str
    (String) The unique identifier of the created destination.
    en_destination_custom_sms_id str
    (String) The unique identifier of the custom_sms_en_destination.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    name str
    The Destintion name.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    type str
    sms_custom.
    updated_at str
    (String) Last updated time.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationCustomSmsId String
    (String) The unique identifier of the custom_sms_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    The Destintion name.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    sms_custom.
    updatedAt String
    (String) Last updated time.

    Import

    You can import the ibm_en_destination_custom_sms resource by using id.

    The id property can be formed from instance_guid, and destination_id in the following format:

    <instance_guid>/<destination_id>

    • instance_guid: A string. Unique identifier for IBM Cloud Event Notifications instance.

    • destination_id: A string. Unique identifier for Destination.

    Example

    $ pulumi import ibm:index/enDestinationCustomSms:EnDestinationCustomSms custom_domain_sms_en_destination <instance_guid>/<destination_id>

    To learn more about importing existing cloud resources, see Importing resources.

    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
    ibm-cloud/terraform-provider-ibm