import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Notification Topic resource in Oracle Cloud Infrastructure Notifications service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/notification/latest/NotificationTopic * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a topic in the specified compartment. For general information about topics, see * [Managing Topics and Subscriptions](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm). * * 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * * 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * Transactions Per Minute (TPM) per-tenancy limit for this operation: 60. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testNotificationTopic = new oci.ons.NotificationTopic("test_notification_topic", { * compartmentId: compartmentId, * name: notificationTopicName, * definedTags: { * "Operations.CostCenter": "42", * }, * description: notificationTopicDescription, * freeformTags: { * Department: "Finance", * }, * }); * ``` * * ## Import * * NotificationTopics can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Ons/notificationTopic:NotificationTopic test_notification_topic "id" * ``` */ export declare class NotificationTopic extends pulumi.CustomResource { /** * Get an existing NotificationTopic resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: NotificationTopicState, opts?: pulumi.CustomResourceOptions): NotificationTopic; /** * Returns true if the given object is an instance of NotificationTopic. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is NotificationTopic; /** * The endpoint for managing subscriptions or publishing messages to the topic. */ readonly apiEndpoint: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the topic in. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The description of the topic being created. Avoid entering confidential information. */ readonly description: pulumi.Output; /** * For optimistic concurrency control. See `if-match`. */ readonly etag: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: 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 */ readonly name: pulumi.Output; /** * A unique short topic Id. This is used only for SMS subscriptions. */ readonly shortTopicId: pulumi.Output; /** * The lifecycle state of the topic. */ readonly state: pulumi.Output; /** * The time the topic was created. */ readonly timeCreated: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ readonly topicId: pulumi.Output; /** * Create a NotificationTopic resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: NotificationTopicArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering NotificationTopic resources. */ export interface NotificationTopicState { /** * The endpoint for managing subscriptions or publishing messages to the topic. */ apiEndpoint?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the topic in. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the topic being created. Avoid entering confidential information. */ description?: pulumi.Input; /** * For optimistic concurrency control. See `if-match`. */ etag?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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 */ name?: pulumi.Input; /** * A unique short topic Id. This is used only for SMS subscriptions. */ shortTopicId?: pulumi.Input; /** * The lifecycle state of the topic. */ state?: pulumi.Input; /** * The time the topic was created. */ timeCreated?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId?: pulumi.Input; } /** * The set of arguments for constructing a NotificationTopic resource. */ export interface NotificationTopicArgs { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the topic in. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the topic being created. Avoid entering confidential information. */ description?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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 */ name?: pulumi.Input; } //# sourceMappingURL=notificationTopic.d.ts.map