Oracle Cloud Infrastructure v3.0.0, Jun 5 25

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

oci.Ons.getNotificationTopics

Explore with Pulumi AI

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

Example Usage

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

const testNotificationTopics = oci.Ons.getNotificationTopics({
    compartmentId: compartmentId,
    id: notificationTopicId,
    name: notificationTopicName,
    state: notificationTopicState,
});

import pulumi
import pulumi_oci as oci

test_notification_topics = oci.Ons.get_notification_topics(compartment_id=compartment_id,
    id=notification_topic_id,
    name=notification_topic_name,
    state=notification_topic_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/ons"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ons.GetNotificationTopics(ctx, &ons.GetNotificationTopicsArgs{
			CompartmentId: compartmentId,
			Id:            pulumi.StringRef(notificationTopicId),
			Name:          pulumi.StringRef(notificationTopicName),
			State:         pulumi.StringRef(notificationTopicState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testNotificationTopics = Oci.Ons.GetNotificationTopics.Invoke(new()
    {
        CompartmentId = compartmentId,
        Id = notificationTopicId,
        Name = notificationTopicName,
        State = notificationTopicState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Ons.OnsFunctions;
import com.pulumi.oci.Ons.inputs.GetNotificationTopicsArgs;
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) {
        final var testNotificationTopics = OnsFunctions.getNotificationTopics(GetNotificationTopicsArgs.builder()
            .compartmentId(compartmentId)
            .id(notificationTopicId)
            .name(notificationTopicName)
            .state(notificationTopicState)
            .build());

    }
}

variables:
  testNotificationTopics:
    fn::invoke:
      function: oci:Ons:getNotificationTopics
      arguments:
        compartmentId: ${compartmentId}
        id: ${notificationTopicId}
        name: ${notificationTopicName}
        state: ${notificationTopicState}

Using getNotificationTopics

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 getNotificationTopics(args: GetNotificationTopicsArgs, opts?: InvokeOptions): Promise<GetNotificationTopicsResult>
function getNotificationTopicsOutput(args: GetNotificationTopicsOutputArgs, opts?: InvokeOptions): Output<GetNotificationTopicsResult>

def get_notification_topics(compartment_id: Optional[str] = None,
                            filters: Optional[Sequence[GetNotificationTopicsFilter]] = None,
                            id: Optional[str] = None,
                            name: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetNotificationTopicsResult
def get_notification_topics_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNotificationTopicsFilterArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetNotificationTopicsResult]

func GetNotificationTopics(ctx *Context, args *GetNotificationTopicsArgs, opts ...InvokeOption) (*GetNotificationTopicsResult, error)
func GetNotificationTopicsOutput(ctx *Context, args *GetNotificationTopicsOutputArgs, opts ...InvokeOption) GetNotificationTopicsResultOutput

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

public static class GetNotificationTopics 
{
    public static Task<GetNotificationTopicsResult> InvokeAsync(GetNotificationTopicsArgs args, InvokeOptions? opts = null)
    public static Output<GetNotificationTopicsResult> Invoke(GetNotificationTopicsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNotificationTopicsResult> getNotificationTopics(GetNotificationTopicsArgs args, InvokeOptions options)
public static Output<GetNotificationTopicsResult> getNotificationTopics(GetNotificationTopicsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Ons/getNotificationTopics:getNotificationTopics
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
Filters List<GetNotificationTopicsFilter>
Id string: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

CompartmentId string: The OCID of the compartment.
Filters []GetNotificationTopicsFilter
Id string: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId String: The OCID of the compartment.
filters List<GetNotificationTopicsFilter>
id String: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId string: The OCID of the compartment.
filters GetNotificationTopicsFilter[]
id string: A filter to only return resources that match the given id exactly.
name string: A filter to only return resources that match the given name exactly.
state string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartment_id str: The OCID of the compartment.
filters Sequence[GetNotificationTopicsFilter]
id str: A filter to only return resources that match the given id exactly.
name str: A filter to only return resources that match the given name exactly.
state str: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId String: The OCID of the compartment.
filters List<Property Map>
id String: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

getNotificationTopics Result

The following output properties are available:

CompartmentId string: The OCID of the compartment for the topic.
NotificationTopics List<GetNotificationTopicsNotificationTopic>: The list of notification_topics.
Filters List<GetNotificationTopicsFilter>
Id string
Name string: The name of the topic.
State string: The lifecycle state of the topic.

CompartmentId string: The OCID of the compartment for the topic.
NotificationTopics []GetNotificationTopicsNotificationTopic: The list of notification_topics.
Filters []GetNotificationTopicsFilter
Id string
Name string: The name of the topic.
State string: The lifecycle state of the topic.

compartmentId String: The OCID of the compartment for the topic.
notificationTopics List<GetNotificationTopicsNotificationTopic>: The list of notification_topics.
filters List<GetNotificationTopicsFilter>
id String
name String: The name of the topic.
state String: The lifecycle state of the topic.

compartmentId string: The OCID of the compartment for the topic.
notificationTopics GetNotificationTopicsNotificationTopic[]: The list of notification_topics.
filters GetNotificationTopicsFilter[]
id string
name string: The name of the topic.
state string: The lifecycle state of the topic.

compartment_id str: The OCID of the compartment for the topic.
notification_topics Sequence[GetNotificationTopicsNotificationTopic]: The list of notification_topics.
filters Sequence[GetNotificationTopicsFilter]
id str
name str: The name of the topic.
state str: The lifecycle state of the topic.

compartmentId String: The OCID of the compartment for the topic.
notificationTopics List<Property Map>: The list of notification_topics.
filters List<Property Map>
id String
name String: The name of the topic.
state String: The lifecycle state of the topic.

Supporting Types

GetNotificationTopicsFilter

Name string: A filter to only return resources that match the given name exactly.
Values List<string>
Regex bool

Name string: A filter to only return resources that match the given name exactly.
Values []string
Regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

name string: A filter to only return resources that match the given name exactly.
values string[]
regex boolean

name str: A filter to only return resources that match the given name exactly.
values Sequence[str]
regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

GetNotificationTopicsNotificationTopic

ApiEndpoint string: The endpoint for managing subscriptions or publishing messages to the topic.
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: 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, string>: 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: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
ShortTopicId string: A unique short topic Id. This is used only for SMS subscriptions.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
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.
DefinedTags map[string]string: 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]string: 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: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
ShortTopicId string: A unique short topic Id. This is used only for SMS subscriptions.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
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.
definedTags Map<String,String>: 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,String>: 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: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
shortTopicId String: A unique short topic Id. This is used only for SMS subscriptions.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
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.
definedTags {[key: string]: string}: 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]: string}: 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: A filter to only return resources that match the given id exactly.
name string: A filter to only return resources that match the given name exactly.
shortTopicId string: A unique short topic Id. This is used only for SMS subscriptions.
state string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
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.
defined_tags Mapping[str, str]: 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, str]: 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: A filter to only return resources that match the given id exactly.
name str: A filter to only return resources that match the given name exactly.
short_topic_id str: A unique short topic Id. This is used only for SMS subscriptions.
state str: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
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.
definedTags Map<String>: 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>: 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: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
shortTopicId String: A unique short topic Id. This is used only for SMS subscriptions.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
timeCreated String: The time the topic was created.
topicId String: The OCID of the topic.

Package Details

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

Oracle Cloud Infrastructure v3.0.0 published on Thursday, Jun 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.Ons.getNotificationTopics

On this page

On this page

Example Usage

Using getNotificationTopics

getNotificationTopics Result

Supporting Types

GetNotificationTopicsFilter

GetNotificationTopicsNotificationTopic

Package Details

On this page

On this page