steampipe plugin install oci

Table: oci_ons_notification_topic - Query OCI Notification Service Topics using SQL

The Oracle Cloud Infrastructure (OCI) Notification Service is a cloud native messaging service that allows for the broadcast of messages to distributed components, such as email and PagerDuty. It is used to send notifications to large numbers of recipients, and ensures that messages are delivered to all subscribers. This service is often used for alerting, coordination, and response in distributed systems.

Table Usage Guide

The oci_ons_notification_topic table provides insights into topics within OCI Notification Service. As a Systems Administrator, explore topic-specific details through this table, including the topic's ARN, name, and status. Utilize it to uncover information about topics, such as those with a specific status, the messages sent through each topic, and the verification of topic configurations.

Examples

Basic info

Explore the various notification topics within your Oracle Cloud Infrastructure to understand their lifecycle states and associated API endpoints. This could be useful for assessing the overall configuration and status of your notification system.

select
name,
topic_id,
api_endpoint,
short_topic_id,
lifecycle_state,
description
from
oci_ons_notification_topic;
select
name,
topic_id,
api_endpoint,
short_topic_id,
lifecycle_state,
description
from
oci_ons_notification_topic;

List inactive topics

Explore which notification topics are currently inactive within your Oracle Cloud Infrastructure. This can help you identify areas that may need attention or cleanup to optimize your resources.

select
name,
lifecycle_state
from
oci_ons_notification_topic
where
lifecycle_state <> 'ACTIVE';
select
name,
lifecycle_state
from
oci_ons_notification_topic
where
lifecycle_state <> 'ACTIVE';

Schema for oci_ons_notification_topic

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
api_endpointtextThe endpoint for managing subscriptions or publishing messages to the topic.
compartment_idtext=The OCID of the compartment in Tenant in which the resource is located.
defined_tagsjsonbDefined tags for resource. Defined tags are set up in your tenancy by an administrator. Only users granted permission to work with the defined tags can apply them to resources.
descriptiontextThe description of the topic.
etagtextUsed for optimistic concurrency control.
freeform_tagsjsonbFree-form tags for resource. This tags can be applied by any user with permissions on the resource.
lifecycle_statetext=The lifecycle state of the topic.
nametext=The name of the topic.
regiontextThe OCI region in which the resource is located.
short_topic_idtextA unique short topic Id. This is used only for SMS subscriptions.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
tagsjsonbA map of tags for the resource.
tenant_idtext=, !=, ~~, ~~*, !~~, !~~*The OCID of the Tenant in which the resource is located.
tenant_nametextThe name of the Tenant in which the resource is located.
time_createdtimestamp with time zoneThe time the topic was created.
titletextTitle of the resource.
topic_idtext=The OCID of the topic.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- oci

You can pass the configuration to the command with the --config argument:

steampipe_export_oci --config '<your_config>' oci_ons_notification_topic