Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. EnSubscriptionSms
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.EnSubscriptionSms

ibm
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Create, update, or delete an SMS subscription by using IBM Cloud™ Event Notifications.

    Example Usage

    Create EnSubscriptionSms Resource

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

    Constructor syntax

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

@overload
def EnSubscriptionSms(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      attributes: Optional[EnSubscriptionSmsAttributesArgs] = None,
                      destination_id: Optional[str] = None,
                      instance_guid: Optional[str] = None,
                      topic_id: Optional[str] = None,
                      description: Optional[str] = None,
                      en_subscription_sms_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewEnSubscriptionSms(ctx *Context, name string, args EnSubscriptionSmsArgs, opts ...ResourceOption) (*EnSubscriptionSms, error)
    public EnSubscriptionSms(string name, EnSubscriptionSmsArgs args, CustomResourceOptions? opts = null)
    public EnSubscriptionSms(String name, EnSubscriptionSmsArgs args)
public EnSubscriptionSms(String name, EnSubscriptionSmsArgs args, CustomResourceOptions options)

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


    resource "ibm_en_subscription_sms" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnSubscriptionSmsArgs
    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 EnSubscriptionSmsArgs
    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 EnSubscriptionSmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnSubscriptionSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnSubscriptionSmsArgs
    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 enSubscriptionSmsResource = new Ibm.EnSubscriptionSms("enSubscriptionSmsResource", new()
{
    Attributes = new Ibm.Inputs.EnSubscriptionSmsAttributesArgs
    {
        Inviteds = new[]
        {
            "string",
        },
        Subscribeds = new[]
        {
            "string",
        },
        Unsubscribeds = new[]
        {
            "string",
        },
    },
    DestinationId = "string",
    InstanceGuid = "string",
    TopicId = "string",
    Description = "string",
    EnSubscriptionSmsId = "string",
    Name = "string",
});

    example, err := ibm.NewEnSubscriptionSms(ctx, "enSubscriptionSmsResource", &ibm.EnSubscriptionSmsArgs{
	Attributes: &ibm.EnSubscriptionSmsAttributesArgs{
		Inviteds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Subscribeds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Unsubscribeds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	DestinationId:       pulumi.String("string"),
	InstanceGuid:        pulumi.String("string"),
	TopicId:             pulumi.String("string"),
	Description:         pulumi.String("string"),
	EnSubscriptionSmsId: pulumi.String("string"),
	Name:                pulumi.String("string"),
})

    resource "ibm_en_subscription_sms" "enSubscriptionSmsResource" {
  lifecycle {
    create_before_destroy = true
  }
  attributes = {
    inviteds      = ["string"]
    subscribeds   = ["string"]
    unsubscribeds = ["string"]
  }
  destination_id         = "string"
  instance_guid          = "string"
  topic_id               = "string"
  description            = "string"
  en_subscription_sms_id = "string"
  name                   = "string"
}

    var enSubscriptionSmsResource = new EnSubscriptionSms("enSubscriptionSmsResource", EnSubscriptionSmsArgs.builder()
    .attributes(EnSubscriptionSmsAttributesArgs.builder()
        .inviteds("string")
        .subscribeds("string")
        .unsubscribeds("string")
        .build())
    .destinationId("string")
    .instanceGuid("string")
    .topicId("string")
    .description("string")
    .enSubscriptionSmsId("string")
    .name("string")
    .build());

    en_subscription_sms_resource = ibm.EnSubscriptionSms("enSubscriptionSmsResource",
    attributes={
        "inviteds": ["string"],
        "subscribeds": ["string"],
        "unsubscribeds": ["string"],
    },
    destination_id="string",
    instance_guid="string",
    topic_id="string",
    description="string",
    en_subscription_sms_id="string",
    name="string")

    const enSubscriptionSmsResource = new ibm.EnSubscriptionSms("enSubscriptionSmsResource", {
    attributes: {
        inviteds: ["string"],
        subscribeds: ["string"],
        unsubscribeds: ["string"],
    },
    destinationId: "string",
    instanceGuid: "string",
    topicId: "string",
    description: "string",
    enSubscriptionSmsId: "string",
    name: "string",
});

    type: ibm:EnSubscriptionSms
properties:
    attributes:
        inviteds:
            - string
        subscribeds:
            - string
        unsubscribeds:
            - string
    description: string
    destinationId: string
    enSubscriptionSmsId: string
    instanceGuid: string
    name: string
    topicId: string

    EnSubscriptionSms 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 EnSubscriptionSms resource accepts the following input properties:

    Attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    Name string
    Subscription name.
    Attributes EnSubscriptionSmsAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    Name string
    Subscription name.
    attributes object

    Subscription attributes.

    Nested scheme for attributes:

    destination_id string
    Destination ID.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    topic_id string
    Topic ID.
    description string
    Subscription description.
    en_subscription_sms_id string
    (String) The unique identifier of the sms_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionSmsId String
    (String) The unique identifier of the sms_subscription.
    name String
    Subscription name.
    attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    destinationId string
    Destination ID.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId string
    Topic ID.
    description string
    Subscription description.
    enSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionSmsAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    destination_id str
    Destination ID.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    topic_id str
    Topic ID.
    description str
    Subscription description.
    en_subscription_sms_id str
    (String) The unique identifier of the sms_subscription.
    name str
    Subscription name.
    attributes Property Map

    Subscription attributes.

    Nested scheme for attributes:

    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionSmsId String
    (String) The unique identifier of the sms_subscription.
    name String
    Subscription name.

    Outputs

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

    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    destination_name string
    (String) The Destination name.
    destination_type string
    (String) The type of Destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscription_id string
    (String) The unique identifier of the created subscription.
    topic_name string
    (String) Name of the topic.
    updated_at string
    (String) Last updated time.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.
    destinationName string
    (String) The Destination name.
    destinationType string
    (String) The type of Destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscriptionId string
    (String) The unique identifier of the created subscription.
    topicName string
    (String) Name of the topic.
    updatedAt string
    (String) Last updated time.
    destination_name str
    (String) The Destination name.
    destination_type str
    (String) The type of Destination.
    id str
    The provider-assigned unique ID for this managed resource.
    subscription_id str
    (String) The unique identifier of the created subscription.
    topic_name str
    (String) Name of the topic.
    updated_at str
    (String) Last updated time.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnSubscriptionSms Resource

    Get an existing EnSubscriptionSms 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?: EnSubscriptionSmsState, opts?: CustomResourceOptions): EnSubscriptionSms
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[EnSubscriptionSmsAttributesArgs] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_name: Optional[str] = None,
        destination_type: Optional[str] = None,
        en_subscription_sms_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        name: Optional[str] = None,
        subscription_id: Optional[str] = None,
        topic_id: Optional[str] = None,
        topic_name: Optional[str] = None,
        updated_at: Optional[str] = None) -> EnSubscriptionSms
    func GetEnSubscriptionSms(ctx *Context, name string, id IDInput, state *EnSubscriptionSmsState, opts ...ResourceOption) (*EnSubscriptionSms, error)
    public static EnSubscriptionSms Get(string name, Input<string> id, EnSubscriptionSmsState? state, CustomResourceOptions? opts = null)
    public static EnSubscriptionSms get(String name, Output<String> id, EnSubscriptionSmsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnSubscriptionSms    get:      id: ${id}
    import {
  to = ibm_en_subscription_sms.example
  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:
    Attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    EnSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    Subscription name.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicId string
    Topic ID.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    Attributes EnSubscriptionSmsAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    EnSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    Subscription name.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicId string
    Topic ID.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    attributes object

    Subscription attributes.

    Nested scheme for attributes:

    description string
    Subscription description.
    destination_id string
    Destination ID.
    destination_name string
    (String) The Destination name.
    destination_type string
    (String) The type of Destination.
    en_subscription_sms_id string
    (String) The unique identifier of the sms_subscription.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    Subscription name.
    subscription_id string
    (String) The unique identifier of the created subscription.
    topic_id string
    Topic ID.
    topic_name string
    (String) Name of the topic.
    updated_at string
    (String) Last updated time.
    attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    enSubscriptionSmsId String
    (String) The unique identifier of the sms_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    Subscription name.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicId String
    Topic ID.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.
    attributes EnSubscriptionSmsAttributes

    Subscription attributes.

    Nested scheme for attributes:

    description string
    Subscription description.
    destinationId string
    Destination ID.
    destinationName string
    (String) The Destination name.
    destinationType string
    (String) The type of Destination.
    enSubscriptionSmsId string
    (String) The unique identifier of the sms_subscription.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    Subscription name.
    subscriptionId string
    (String) The unique identifier of the created subscription.
    topicId string
    Topic ID.
    topicName string
    (String) Name of the topic.
    updatedAt string
    (String) Last updated time.
    attributes EnSubscriptionSmsAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    description str
    Subscription description.
    destination_id str
    Destination ID.
    destination_name str
    (String) The Destination name.
    destination_type str
    (String) The type of Destination.
    en_subscription_sms_id str
    (String) The unique identifier of the sms_subscription.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    name str
    Subscription name.
    subscription_id str
    (String) The unique identifier of the created subscription.
    topic_id str
    Topic ID.
    topic_name str
    (String) Name of the topic.
    updated_at str
    (String) Last updated time.
    attributes Property Map

    Subscription attributes.

    Nested scheme for attributes:

    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    enSubscriptionSmsId String
    (String) The unique identifier of the sms_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    Subscription name.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicId String
    Topic ID.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.

    Supporting Types

    EnSubscriptionSmsAttributes, EnSubscriptionSmsAttributesArgs

    Adds List<string>

    Deprecated: Deprecated

    Inviteds List<string>
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    Removes List<string>

    Deprecated: Deprecated

    Subscribeds List<string>
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    Unsubscribeds List<string>
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    Adds []string

    Deprecated: Deprecated

    Inviteds []string
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    Removes []string

    Deprecated: Deprecated

    Subscribeds []string
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    Unsubscribeds []string
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    adds list(string)

    Deprecated: Deprecated

    inviteds list(string)
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    removes list(string)

    Deprecated: Deprecated

    subscribeds list(string)
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds list(string)
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    adds List<String>

    Deprecated: Deprecated

    inviteds List<String>
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    removes List<String>

    Deprecated: Deprecated

    subscribeds List<String>
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds List<String>
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    adds string[]

    Deprecated: Deprecated

    inviteds string[]
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    removes string[]

    Deprecated: Deprecated

    subscribeds string[]
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds string[]
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    adds Sequence[str]

    Deprecated: Deprecated

    inviteds Sequence[str]
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    removes Sequence[str]

    Deprecated: Deprecated

    subscribeds Sequence[str]
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds Sequence[str]
    Phone numbers that have unsubscribed. Populated by the service; read-only.
    adds List<String>

    Deprecated: Deprecated

    inviteds List<String>
    The phone numbers to invite. Add a number by adding it to this list; remove a number by removing it from this list.
    removes List<String>

    Deprecated: Deprecated

    subscribeds List<String>
    Phone numbers that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds List<String>
    Phone numbers that have unsubscribed. Populated by the service; read-only.

    Import

    You can import the ibm_en_subscription_sms resource by using id.

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

    <instance_guid>/<subscription_id>

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

    • subscription_id: A string. Unique identifier for Subscription.

    Example

    $ pulumi import ibm:index/enSubscriptionSms:EnSubscriptionSms sms_subscription <instance_guid>/<subscription_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
    Viewing docs for ibm 2.7.0
    published on Wednesday, Oct 7, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial