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

ibm.EnSubscriptionCos

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 COS subscription by using IBM Cloud™ Event Notifications.

    Example Usage

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

const cosSubscription = new ibm.EnSubscriptionCos("cosSubscription", {
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    description: "IBM Cloud Object Storage destination subscription for Event Notification",
    destinationId: ibm_en_destination_cos.cos_destination.destination_id,
    topicId: ibm_en_topic.topic1.topic_id,
});

    import pulumi
import pulumi_ibm as ibm

cos_subscription = ibm.EnSubscriptionCos("cosSubscription",
    instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    description="IBM Cloud Object Storage destination subscription for Event Notification",
    destination_id=ibm_en_destination_cos["cos_destination"]["destination_id"],
    topic_id=ibm_en_topic["topic1"]["topic_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.NewEnSubscriptionCos(ctx, "cosSubscription", &ibm.EnSubscriptionCosArgs{
			InstanceGuid:  pulumi.Any(ibm_resource_instance.En_terraform_test_resource.Guid),
			Description:   pulumi.String("IBM Cloud Object Storage destination subscription for Event Notification"),
			DestinationId: pulumi.Any(ibm_en_destination_cos.Cos_destination.Destination_id),
			TopicId:       pulumi.Any(ibm_en_topic.Topic1.Topic_id),
		})
		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 cosSubscription = new Ibm.EnSubscriptionCos("cosSubscription", new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        Description = "IBM Cloud Object Storage destination subscription for Event Notification",
        DestinationId = ibm_en_destination_cos.Cos_destination.Destination_id,
        TopicId = ibm_en_topic.Topic1.Topic_id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnSubscriptionCos;
import com.pulumi.ibm.EnSubscriptionCosArgs;
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 cosSubscription = new EnSubscriptionCos("cosSubscription", EnSubscriptionCosArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .description("IBM Cloud Object Storage destination subscription for Event Notification")
            .destinationId(ibm_en_destination_cos.cos_destination().destination_id())
            .topicId(ibm_en_topic.topic1().topic_id())
            .build());

    }
}

    resources:
  cosSubscription:
    type: ibm:EnSubscriptionCos
    properties:
      instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
      description: IBM Cloud Object Storage destination subscription for Event Notification
      destinationId: ${ibm_en_destination_cos.cos_destination.destination_id}
      topicId: ${ibm_en_topic.topic1.topic_id}

    Create EnSubscriptionCos Resource

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

    Constructor syntax

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

@overload
def EnSubscriptionCos(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      destination_id: Optional[str] = None,
                      instance_guid: Optional[str] = None,
                      topic_id: Optional[str] = None,
                      description: Optional[str] = None,
                      en_subscription_cos_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewEnSubscriptionCos(ctx *Context, name string, args EnSubscriptionCosArgs, opts ...ResourceOption) (*EnSubscriptionCos, error)
    public EnSubscriptionCos(string name, EnSubscriptionCosArgs args, CustomResourceOptions? opts = null)
    public EnSubscriptionCos(String name, EnSubscriptionCosArgs args)
public EnSubscriptionCos(String name, EnSubscriptionCosArgs args, CustomResourceOptions options)

    type: ibm:EnSubscriptionCos
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 EnSubscriptionCosArgs
    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 EnSubscriptionCosArgs
    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 EnSubscriptionCosArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnSubscriptionCosArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnSubscriptionCosArgs
    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 enSubscriptionCosResource = new Ibm.EnSubscriptionCos("enSubscriptionCosResource", new()
{
    DestinationId = "string",
    InstanceGuid = "string",
    TopicId = "string",
    Description = "string",
    EnSubscriptionCosId = "string",
    Name = "string",
});

    example, err := ibm.NewEnSubscriptionCos(ctx, "enSubscriptionCosResource", &ibm.EnSubscriptionCosArgs{
	DestinationId:       pulumi.String("string"),
	InstanceGuid:        pulumi.String("string"),
	TopicId:             pulumi.String("string"),
	Description:         pulumi.String("string"),
	EnSubscriptionCosId: pulumi.String("string"),
	Name:                pulumi.String("string"),
})

    var enSubscriptionCosResource = new EnSubscriptionCos("enSubscriptionCosResource", EnSubscriptionCosArgs.builder()
    .destinationId("string")
    .instanceGuid("string")
    .topicId("string")
    .description("string")
    .enSubscriptionCosId("string")
    .name("string")
    .build());

    en_subscription_cos_resource = ibm.EnSubscriptionCos("enSubscriptionCosResource",
    destination_id="string",
    instance_guid="string",
    topic_id="string",
    description="string",
    en_subscription_cos_id="string",
    name="string")

    const enSubscriptionCosResource = new ibm.EnSubscriptionCos("enSubscriptionCosResource", {
    destinationId: "string",
    instanceGuid: "string",
    topicId: "string",
    description: "string",
    enSubscriptionCosId: "string",
    name: "string",
});

    type: ibm:EnSubscriptionCos
properties:
    description: string
    destinationId: string
    enSubscriptionCosId: string
    instanceGuid: string
    name: string
    topicId: string

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

    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionCosId string
    (String) The unique identifier of the cos_subscription.
    Name string
    Subscription name.
    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionCosId string
    (String) The unique identifier of the cos_subscription.
    Name string
    Subscription name.
    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionCosId String
    (String) The unique identifier of the cos_subscription.
    name String
    Subscription name.
    destinationId string
    Destination ID.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId string
    Topic ID.
    description string
    Subscription description.
    enSubscriptionCosId string
    (String) The unique identifier of the cos_subscription.
    name string
    Subscription name.
    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_cos_id str
    (String) The unique identifier of the cos_subscription.
    name str
    Subscription name.
    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionCosId String
    (String) The unique identifier of the cos_subscription.
    name String
    Subscription name.

    Outputs

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

    DestinationName string
    The Destintion name.
    DestinationType 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
    Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    DestinationName string
    The Destintion name.
    DestinationType 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
    Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    destinationName String
    The Destintion name.
    destinationType 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
    Name of the topic.
    updatedAt String
    (String) Last updated time.
    destinationName string
    The Destintion name.
    destinationType 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
    Name of the topic.
    updatedAt string
    (String) Last updated time.
    destination_name str
    The Destintion name.
    destination_type str
    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
    Name of the topic.
    updated_at str
    (String) Last updated time.
    destinationName String
    The Destintion name.
    destinationType 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
    Name of the topic.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnSubscriptionCos Resource

    Get an existing EnSubscriptionCos 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?: EnSubscriptionCosState, opts?: CustomResourceOptions): EnSubscriptionCos
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_name: Optional[str] = None,
        destination_type: Optional[str] = None,
        en_subscription_cos_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) -> EnSubscriptionCos
    func GetEnSubscriptionCos(ctx *Context, name string, id IDInput, state *EnSubscriptionCosState, opts ...ResourceOption) (*EnSubscriptionCos, error)
    public static EnSubscriptionCos Get(string name, Input<string> id, EnSubscriptionCosState? state, CustomResourceOptions? opts = null)
    public static EnSubscriptionCos get(String name, Output<String> id, EnSubscriptionCosState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnSubscriptionCos    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:
    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    The Destintion name.
    DestinationType string
    The type of Destination.
    EnSubscriptionCosId string
    (String) The unique identifier of the cos_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
    Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    The Destintion name.
    DestinationType string
    The type of Destination.
    EnSubscriptionCosId string
    (String) The unique identifier of the cos_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
    Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    The Destintion name.
    destinationType String
    The type of Destination.
    enSubscriptionCosId String
    (String) The unique identifier of the cos_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
    Name of the topic.
    updatedAt String
    (String) Last updated time.
    description string
    Subscription description.
    destinationId string
    Destination ID.
    destinationName string
    The Destintion name.
    destinationType string
    The type of Destination.
    enSubscriptionCosId string
    (String) The unique identifier of the cos_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
    Name of the topic.
    updatedAt string
    (String) Last updated time.
    description str
    Subscription description.
    destination_id str
    Destination ID.
    destination_name str
    The Destintion name.
    destination_type str
    The type of Destination.
    en_subscription_cos_id str
    (String) The unique identifier of the cos_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
    Name of the topic.
    updated_at str
    (String) Last updated time.
    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    The Destintion name.
    destinationType String
    The type of Destination.
    enSubscriptionCosId String
    (String) The unique identifier of the cos_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
    Name of the topic.
    updatedAt String
    (String) Last updated time.

    Import

    You can import the ibm_en_subscription_cos 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/enSubscriptionCos:EnSubscriptionCos cos_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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm