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

ibm.EnSubscriptionScheduler

Explore with Pulumi AI

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

    Create, update, or delete a Scheduler subscription by using IBM Cloud™ Event Notifications.

    Create EnSubscriptionScheduler Resource

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

    Constructor syntax

    new EnSubscriptionScheduler(name: string, args: EnSubscriptionSchedulerArgs, opts?: CustomResourceOptions);
    @overload
    def EnSubscriptionScheduler(resource_name: str,
                                args: EnSubscriptionSchedulerArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnSubscriptionScheduler(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_scheduler_id: Optional[str] = None,
                                name: Optional[str] = None)
    func NewEnSubscriptionScheduler(ctx *Context, name string, args EnSubscriptionSchedulerArgs, opts ...ResourceOption) (*EnSubscriptionScheduler, error)
    public EnSubscriptionScheduler(string name, EnSubscriptionSchedulerArgs args, CustomResourceOptions? opts = null)
    public EnSubscriptionScheduler(String name, EnSubscriptionSchedulerArgs args)
    public EnSubscriptionScheduler(String name, EnSubscriptionSchedulerArgs args, CustomResourceOptions options)
    
    type: ibm:EnSubscriptionScheduler
    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 EnSubscriptionSchedulerArgs
    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 EnSubscriptionSchedulerArgs
    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 EnSubscriptionSchedulerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnSubscriptionSchedulerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnSubscriptionSchedulerArgs
    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 enSubscriptionSchedulerResource = new Ibm.EnSubscriptionScheduler("enSubscriptionSchedulerResource", new()
    {
        DestinationId = "string",
        InstanceGuid = "string",
        TopicId = "string",
        Description = "string",
        EnSubscriptionSchedulerId = "string",
        Name = "string",
    });
    
    example, err := ibm.NewEnSubscriptionScheduler(ctx, "enSubscriptionSchedulerResource", &ibm.EnSubscriptionSchedulerArgs{
    	DestinationId:             pulumi.String("string"),
    	InstanceGuid:              pulumi.String("string"),
    	TopicId:                   pulumi.String("string"),
    	Description:               pulumi.String("string"),
    	EnSubscriptionSchedulerId: pulumi.String("string"),
    	Name:                      pulumi.String("string"),
    })
    
    var enSubscriptionSchedulerResource = new EnSubscriptionScheduler("enSubscriptionSchedulerResource", EnSubscriptionSchedulerArgs.builder()
        .destinationId("string")
        .instanceGuid("string")
        .topicId("string")
        .description("string")
        .enSubscriptionSchedulerId("string")
        .name("string")
        .build());
    
    en_subscription_scheduler_resource = ibm.EnSubscriptionScheduler("enSubscriptionSchedulerResource",
        destination_id="string",
        instance_guid="string",
        topic_id="string",
        description="string",
        en_subscription_scheduler_id="string",
        name="string")
    
    const enSubscriptionSchedulerResource = new ibm.EnSubscriptionScheduler("enSubscriptionSchedulerResource", {
        destinationId: "string",
        instanceGuid: "string",
        topicId: "string",
        description: "string",
        enSubscriptionSchedulerId: "string",
        name: "string",
    });
    
    type: ibm:EnSubscriptionScheduler
    properties:
        description: string
        destinationId: string
        enSubscriptionSchedulerId: string
        instanceGuid: string
        name: string
        topicId: string
    

    EnSubscriptionScheduler 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 EnSubscriptionScheduler 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.
    EnSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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.
    EnSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId String
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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_scheduler_id str
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId String
    (String) The unique identifier of the scheduler_subscription.
    name String
    Subscription name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EnSubscriptionScheduler 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 EnSubscriptionScheduler Resource

    Get an existing EnSubscriptionScheduler 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?: EnSubscriptionSchedulerState, opts?: CustomResourceOptions): EnSubscriptionScheduler
    @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_scheduler_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) -> EnSubscriptionScheduler
    func GetEnSubscriptionScheduler(ctx *Context, name string, id IDInput, state *EnSubscriptionSchedulerState, opts ...ResourceOption) (*EnSubscriptionScheduler, error)
    public static EnSubscriptionScheduler Get(string name, Input<string> id, EnSubscriptionSchedulerState? state, CustomResourceOptions? opts = null)
    public static EnSubscriptionScheduler get(String name, Output<String> id, EnSubscriptionSchedulerState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnSubscriptionScheduler    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.
    EnSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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.
    EnSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId String
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId string
    (String) The unique identifier of the scheduler_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_scheduler_id str
    (String) The unique identifier of the scheduler_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.
    enSubscriptionSchedulerId String
    (String) The unique identifier of the scheduler_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_scheduler 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/enSubscriptionScheduler:EnSubscriptionScheduler scheduler_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