1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Ons
  5. NotificationTopic
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Ons.NotificationTopic

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This resource provides the Notification Topic resource in Oracle Cloud Infrastructure Notifications service.

    Creates a topic in the specified compartment. For general information about topics, see Managing Topics and Subscriptions.

    For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see Overview of the IAM Service.

    You must specify a display name for the topic.

    All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testNotificationTopic = new Oci.Ons.NotificationTopic("testNotificationTopic", new()
        {
            CompartmentId = @var.Compartment_id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = @var.Notification_topic_description,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Ons"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Ons.NewNotificationTopic(ctx, "testNotificationTopic", &Ons.NotificationTopicArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			Description: pulumi.Any(_var.Notification_topic_description),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Ons.NotificationTopic;
    import com.pulumi.oci.Ons.NotificationTopicArgs;
    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 testNotificationTopic = new NotificationTopic("testNotificationTopic", NotificationTopicArgs.builder()        
                .compartmentId(var_.compartment_id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(var_.notification_topic_description())
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_notification_topic = oci.ons.NotificationTopic("testNotificationTopic",
        compartment_id=var["compartment_id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=var["notification_topic_description"],
        freeform_tags={
            "Department": "Finance",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testNotificationTopic = new oci.ons.NotificationTopic("testNotificationTopic", {
        compartmentId: _var.compartment_id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: _var.notification_topic_description,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    resources:
      testNotificationTopic:
        type: oci:Ons:NotificationTopic
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          #Optional
          definedTags:
            Operations.CostCenter: '42'
          description: ${var.notification_topic_description}
          freeformTags:
            Department: Finance
    

    Create NotificationTopic Resource

    new NotificationTopic(name: string, args: NotificationTopicArgs, opts?: CustomResourceOptions);
    @overload
    def NotificationTopic(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          compartment_id: Optional[str] = None,
                          defined_tags: Optional[Mapping[str, Any]] = None,
                          description: Optional[str] = None,
                          freeform_tags: Optional[Mapping[str, Any]] = None,
                          name: Optional[str] = None)
    @overload
    def NotificationTopic(resource_name: str,
                          args: NotificationTopicArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewNotificationTopic(ctx *Context, name string, args NotificationTopicArgs, opts ...ResourceOption) (*NotificationTopic, error)
    public NotificationTopic(string name, NotificationTopicArgs args, CustomResourceOptions? opts = null)
    public NotificationTopic(String name, NotificationTopicArgs args)
    public NotificationTopic(String name, NotificationTopicArgs args, CustomResourceOptions options)
    
    type: oci:Ons:NotificationTopic
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args NotificationTopicArgs
    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 NotificationTopicArgs
    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 NotificationTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationTopicArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    NotificationTopic Resource Properties

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

    Inputs

    The NotificationTopic resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment to create the topic in.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name str

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    ApiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    Etag string
    For optimistic concurrency control. See if-match.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    State string
    The lifecycle state of the topic.
    TimeCreated string
    The time the topic was created.
    TopicId string
    The OCID of the topic.
    ApiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    Etag string
    For optimistic concurrency control. See if-match.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    State string
    The lifecycle state of the topic.
    TimeCreated string
    The time the topic was created.
    TopicId string
    The OCID of the topic.
    apiEndpoint String
    The endpoint for managing subscriptions or publishing messages to the topic.
    etag String
    For optimistic concurrency control. See if-match.
    id String
    The provider-assigned unique ID for this managed resource.
    shortTopicId String
    A unique short topic Id. This is used only for SMS subscriptions.
    state String
    The lifecycle state of the topic.
    timeCreated String
    The time the topic was created.
    topicId String
    The OCID of the topic.
    apiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    etag string
    For optimistic concurrency control. See if-match.
    id string
    The provider-assigned unique ID for this managed resource.
    shortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    state string
    The lifecycle state of the topic.
    timeCreated string
    The time the topic was created.
    topicId string
    The OCID of the topic.
    api_endpoint str
    The endpoint for managing subscriptions or publishing messages to the topic.
    etag str
    For optimistic concurrency control. See if-match.
    id str
    The provider-assigned unique ID for this managed resource.
    short_topic_id str
    A unique short topic Id. This is used only for SMS subscriptions.
    state str
    The lifecycle state of the topic.
    time_created str
    The time the topic was created.
    topic_id str
    The OCID of the topic.
    apiEndpoint String
    The endpoint for managing subscriptions or publishing messages to the topic.
    etag String
    For optimistic concurrency control. See if-match.
    id String
    The provider-assigned unique ID for this managed resource.
    shortTopicId String
    A unique short topic Id. This is used only for SMS subscriptions.
    state String
    The lifecycle state of the topic.
    timeCreated String
    The time the topic was created.
    topicId String
    The OCID of the topic.

    Look up Existing NotificationTopic Resource

    Get an existing NotificationTopic 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?: NotificationTopicState, opts?: CustomResourceOptions): NotificationTopic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_endpoint: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            etag: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            name: Optional[str] = None,
            short_topic_id: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            topic_id: Optional[str] = None) -> NotificationTopic
    func GetNotificationTopic(ctx *Context, name string, id IDInput, state *NotificationTopicState, opts ...ResourceOption) (*NotificationTopic, error)
    public static NotificationTopic Get(string name, Input<string> id, NotificationTopicState? state, CustomResourceOptions? opts = null)
    public static NotificationTopic get(String name, Output<String> id, NotificationTopicState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    CompartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    Etag string
    For optimistic concurrency control. See if-match.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ShortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    State string
    The lifecycle state of the topic.
    TimeCreated string
    The time the topic was created.
    TopicId string
    The OCID of the topic.
    ApiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    CompartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    Etag string
    For optimistic concurrency control. See if-match.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ShortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    State string
    The lifecycle state of the topic.
    TimeCreated string
    The time the topic was created.
    TopicId string
    The OCID of the topic.
    apiEndpoint String
    The endpoint for managing subscriptions or publishing messages to the topic.
    compartmentId String
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    etag String
    For optimistic concurrency control. See if-match.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    shortTopicId String
    A unique short topic Id. This is used only for SMS subscriptions.
    state String
    The lifecycle state of the topic.
    timeCreated String
    The time the topic was created.
    topicId String
    The OCID of the topic.
    apiEndpoint string
    The endpoint for managing subscriptions or publishing messages to the topic.
    compartmentId string
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    etag string
    For optimistic concurrency control. See if-match.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name string

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    shortTopicId string
    A unique short topic Id. This is used only for SMS subscriptions.
    state string
    The lifecycle state of the topic.
    timeCreated string
    The time the topic was created.
    topicId string
    The OCID of the topic.
    api_endpoint str
    The endpoint for managing subscriptions or publishing messages to the topic.
    compartment_id str
    (Updatable) The OCID of the compartment to create the topic in.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    etag str
    For optimistic concurrency control. See if-match.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name str

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    short_topic_id str
    A unique short topic Id. This is used only for SMS subscriptions.
    state str
    The lifecycle state of the topic.
    time_created str
    The time the topic was created.
    topic_id str
    The OCID of the topic.
    apiEndpoint String
    The endpoint for managing subscriptions or publishing messages to the topic.
    compartmentId String
    (Updatable) The OCID of the compartment to create the topic in.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the topic being created. Avoid entering confidential information.
    etag String
    For optimistic concurrency control. See if-match.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    shortTopicId String
    A unique short topic Id. This is used only for SMS subscriptions.
    state String
    The lifecycle state of the topic.
    timeCreated String
    The time the topic was created.
    topicId String
    The OCID of the topic.

    Import

    NotificationTopics can be imported using the id, e.g.

     $ pulumi import oci:Ons/notificationTopic:NotificationTopic test_notification_topic "id"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi