Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getNotificationTopic

This data source provides details about a specific Notification Topic resource in Oracle Cloud Infrastructure Notifications service.

Gets the specified topic’s configuration information.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testNotificationTopic = Output.Create(Oci.Ons.GetNotificationTopic.InvokeAsync(new Oci.Ons.GetNotificationTopicArgs
        {
            TopicId = oci_ons_notification_topic.Test_notification_topic.Id,
        }));
    }

}

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.GetNotificationTopic(ctx, &ons.GetNotificationTopicArgs{
			TopicId: oci_ons_notification_topic.Test_notification_topic.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_notification_topic = oci.Ons.get_notification_topic(topic_id=oci_ons_notification_topic["test_notification_topic"]["id"])

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

const testNotificationTopic = oci.Ons.getNotificationTopic({
    topicId: oci_ons_notification_topic.test_notification_topic.id,
});

Coming soon!

Using getNotificationTopic

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNotificationTopic(args: GetNotificationTopicArgs, opts?: InvokeOptions): Promise<GetNotificationTopicResult>
function getNotificationTopicOutput(args: GetNotificationTopicOutputArgs, opts?: InvokeOptions): Output<GetNotificationTopicResult>

def get_notification_topic(topic_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNotificationTopicResult
def get_notification_topic_output(topic_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNotificationTopicResult]

func GetNotificationTopic(ctx *Context, args *GetNotificationTopicArgs, opts ...InvokeOption) (*GetNotificationTopicResult, error)
func GetNotificationTopicOutput(ctx *Context, args *GetNotificationTopicOutputArgs, opts ...InvokeOption) GetNotificationTopicResultOutput

> Note: This function is named GetNotificationTopic in the Go SDK.

public static class GetNotificationTopic 
{
    public static Task<GetNotificationTopicResult> InvokeAsync(GetNotificationTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetNotificationTopicResult> Invoke(GetNotificationTopicInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNotificationTopicResult> getNotificationTopic(GetNotificationTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:Ons/getNotificationTopic:getNotificationTopic
  Arguments:
    # Arguments dictionary

The following arguments are supported:

TopicId string: The OCID of the topic to retrieve.

TopicId string: The OCID of the topic to retrieve.

topicId String: The OCID of the topic to retrieve.

topicId string: The OCID of the topic to retrieve.

topic_id str: The OCID of the topic to retrieve.

topicId String: The OCID of the topic to retrieve.

getNotificationTopic Result

The following output properties are available:

ApiEndpoint string: The endpoint for managing subscriptions or publishing messages to the topic.
CompartmentId string: The OCID of the compartment for the topic.
DefinedTags Dictionary<string, object>: 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: The description of the topic.
Etag string: For optimistic concurrency control. See if-match.
FreeformTags Dictionary<string, object>: 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"}
Id string
Name string: The name of the topic.
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: The OCID of the compartment for the topic.
DefinedTags map[string]interface{}: 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: The description of the topic.
Etag string: For optimistic concurrency control. See if-match.
FreeformTags map[string]interface{}: 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"}
Id string
Name string: The name of the topic.
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: The OCID of the compartment for the topic.
definedTags Map<String,Object>: 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: The description of the topic.
etag String: For optimistic concurrency control. See if-match.
freeformTags Map<String,Object>: 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"}
id String
name String: The name of the topic.
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: The OCID of the compartment for the topic.
definedTags {[key: string]: any}: 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: The description of the topic.
etag string: For optimistic concurrency control. See if-match.
freeformTags {[key: string]: any}: 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"}
id string
name string: The name of the topic.
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: The OCID of the compartment for the topic.
defined_tags Mapping[str, Any]: 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: The description of the topic.
etag str: For optimistic concurrency control. See if-match.
freeform_tags Mapping[str, Any]: 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"}
id str
name str: The name of the topic.
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: The OCID of the compartment for the topic.
definedTags Map<Any>: 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: The description of the topic.
etag String: For optimistic concurrency control. See if-match.
freeformTags Map<Any>: 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"}
id String
name String: The name of the topic.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.