1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Ons
  5. Subscription
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.Ons.Subscription

Explore with Pulumi AI

This resource provides the Subscription resource in Oracle Cloud Infrastructure Notifications service.

Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in “Pending” status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription.

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

Example Usage

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

const testSubscription = new oci.ons.Subscription("test_subscription", {
    compartmentId: compartmentId,
    endpoint: subscriptionEndpoint,
    protocol: subscriptionProtocol,
    topicId: testNotificationTopic.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    freeformTags: {
        Department: "Finance",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_subscription = oci.ons.Subscription("test_subscription",
    compartment_id=compartment_id,
    endpoint=subscription_endpoint,
    protocol=subscription_protocol,
    topic_id=test_notification_topic["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    freeform_tags={
        "Department": "Finance",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ons.NewSubscription(ctx, "test_subscription", &ons.SubscriptionArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Endpoint:      pulumi.Any(subscriptionEndpoint),
			Protocol:      pulumi.Any(subscriptionProtocol),
			TopicId:       pulumi.Any(testNotificationTopic.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSubscription = new Oci.Ons.Subscription("test_subscription", new()
    {
        CompartmentId = compartmentId,
        Endpoint = subscriptionEndpoint,
        Protocol = subscriptionProtocol,
        TopicId = testNotificationTopic.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Ons.Subscription;
import com.pulumi.oci.Ons.SubscriptionArgs;
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 testSubscription = new Subscription("testSubscription", SubscriptionArgs.builder()
            .compartmentId(compartmentId)
            .endpoint(subscriptionEndpoint)
            .protocol(subscriptionProtocol)
            .topicId(testNotificationTopic.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}
Copy
resources:
  testSubscription:
    type: oci:Ons:Subscription
    name: test_subscription
    properties:
      compartmentId: ${compartmentId}
      endpoint: ${subscriptionEndpoint}
      protocol: ${subscriptionProtocol}
      topicId: ${testNotificationTopic.id}
      definedTags:
        Operations.CostCenter: '42'
      freeformTags:
        Department: Finance
Copy

Create Subscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 endpoint: Optional[str] = None,
                 protocol: Optional[str] = None,
                 topic_id: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 delivery_policy: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None)
func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)
type: oci:Ons:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var subscriptionResource = new Oci.Ons.Subscription("subscriptionResource", new()
{
    CompartmentId = "string",
    Endpoint = "string",
    Protocol = "string",
    TopicId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DeliveryPolicy = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ons.NewSubscription(ctx, "subscriptionResource", &ons.SubscriptionArgs{
	CompartmentId: pulumi.String("string"),
	Endpoint:      pulumi.String("string"),
	Protocol:      pulumi.String("string"),
	TopicId:       pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeliveryPolicy: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var subscriptionResource = new com.pulumi.oci.Ons.Subscription("subscriptionResource", com.pulumi.oci.Ons.SubscriptionArgs.builder()
    .compartmentId("string")
    .endpoint("string")
    .protocol("string")
    .topicId("string")
    .definedTags(Map.of("string", "string"))
    .deliveryPolicy("string")
    .freeformTags(Map.of("string", "string"))
    .build());
Copy
subscription_resource = oci.ons.Subscription("subscriptionResource",
    compartment_id="string",
    endpoint="string",
    protocol="string",
    topic_id="string",
    defined_tags={
        "string": "string",
    },
    delivery_policy="string",
    freeform_tags={
        "string": "string",
    })
Copy
const subscriptionResource = new oci.ons.Subscription("subscriptionResource", {
    compartmentId: "string",
    endpoint: "string",
    protocol: "string",
    topicId: "string",
    definedTags: {
        string: "string",
    },
    deliveryPolicy: "string",
    freeformTags: {
        string: "string",
    },
});
Copy
type: oci:Ons:Subscription
properties:
    compartmentId: string
    definedTags:
        string: string
    deliveryPolicy: string
    endpoint: string
    freeformTags:
        string: string
    protocol: string
    topicId: string
Copy

Subscription Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Subscription resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment for the subscription.
Endpoint
This property is required.
Changes to this property will trigger replacement.
string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Protocol
This property is required.
Changes to this property will trigger replacement.
string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

TopicId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the topic for the subscription.

** 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

DefinedTags Dictionary<string, string>
(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"}
DeliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
FreeformTags Dictionary<string, string>
(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"}
CompartmentId This property is required. string
(Updatable) The OCID of the compartment for the subscription.
Endpoint
This property is required.
Changes to this property will trigger replacement.
string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Protocol
This property is required.
Changes to this property will trigger replacement.
string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

TopicId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the topic for the subscription.

** 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

DefinedTags map[string]string
(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"}
DeliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
FreeformTags map[string]string
(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"}
compartmentId This property is required. String
(Updatable) The OCID of the compartment for the subscription.
endpoint
This property is required.
Changes to this property will trigger replacement.
String

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

protocol
This property is required.
Changes to this property will trigger replacement.
String

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

topicId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the topic for the subscription.

** 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

definedTags Map<String,String>
(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"}
deliveryPolicy String
The delivery policy of the subscription. Stored as a JSON string.
freeformTags Map<String,String>
(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"}
compartmentId This property is required. string
(Updatable) The OCID of the compartment for the subscription.
endpoint
This property is required.
Changes to this property will trigger replacement.
string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

protocol
This property is required.
Changes to this property will trigger replacement.
string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

topicId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the topic for the subscription.

** 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

definedTags {[key: string]: string}
(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"}
deliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
freeformTags {[key: string]: string}
(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"}
compartment_id This property is required. str
(Updatable) The OCID of the compartment for the subscription.
endpoint
This property is required.
Changes to this property will trigger replacement.
str

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

protocol
This property is required.
Changes to this property will trigger replacement.
str

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

topic_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the topic for the subscription.

** 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

defined_tags Mapping[str, str]
(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"}
delivery_policy str
The delivery policy of the subscription. Stored as a JSON string.
freeform_tags Mapping[str, str]
(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"}
compartmentId This property is required. String
(Updatable) The OCID of the compartment for the subscription.
endpoint
This property is required.
Changes to this property will trigger replacement.
String

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

protocol
This property is required.
Changes to this property will trigger replacement.
String

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

topicId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the topic for the subscription.

** 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

definedTags Map<String>
(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"}
deliveryPolicy String
The delivery policy of the subscription. Stored as a JSON string.
freeformTags Map<String>
(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"}

Outputs

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

CreatedTime string
The time when this suscription was created.
Etag string
For optimistic concurrency control. See if-match.
Id string
The provider-assigned unique ID for this managed resource.
State string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
CreatedTime string
The time when this suscription was created.
Etag string
For optimistic concurrency control. See if-match.
Id string
The provider-assigned unique ID for this managed resource.
State string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
createdTime String
The time when this suscription was created.
etag String
For optimistic concurrency control. See if-match.
id String
The provider-assigned unique ID for this managed resource.
state String
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
createdTime string
The time when this suscription was created.
etag string
For optimistic concurrency control. See if-match.
id string
The provider-assigned unique ID for this managed resource.
state string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
created_time str
The time when this suscription was created.
etag str
For optimistic concurrency control. See if-match.
id str
The provider-assigned unique ID for this managed resource.
state str
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
createdTime String
The time when this suscription was created.
etag String
For optimistic concurrency control. See if-match.
id String
The provider-assigned unique ID for this managed resource.
state String
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.

Look up Existing Subscription Resource

Get an existing Subscription 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?: SubscriptionState, opts?: CustomResourceOptions): Subscription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        created_time: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        delivery_policy: Optional[str] = None,
        endpoint: Optional[str] = None,
        etag: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        protocol: Optional[str] = None,
        state: Optional[str] = None,
        topic_id: Optional[str] = None) -> Subscription
func GetSubscription(ctx *Context, name string, id IDInput, state *SubscriptionState, opts ...ResourceOption) (*Subscription, error)
public static Subscription Get(string name, Input<string> id, SubscriptionState? state, CustomResourceOptions? opts = null)
public static Subscription get(String name, Output<String> id, SubscriptionState state, CustomResourceOptions options)
resources:  _:    type: oci:Ons:Subscription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CompartmentId string
(Updatable) The OCID of the compartment for the subscription.
CreatedTime string
The time when this suscription was created.
DefinedTags Dictionary<string, string>
(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"}
DeliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
Endpoint Changes to this property will trigger replacement. string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Etag string
For optimistic concurrency control. See if-match.
FreeformTags Dictionary<string, string>
(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"}
Protocol Changes to this property will trigger replacement. string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

State string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
TopicId Changes to this property will trigger replacement. string

The OCID of the topic for the subscription.

** 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 for the subscription.
CreatedTime string
The time when this suscription was created.
DefinedTags map[string]string
(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"}
DeliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
Endpoint Changes to this property will trigger replacement. string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Etag string
For optimistic concurrency control. See if-match.
FreeformTags map[string]string
(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"}
Protocol Changes to this property will trigger replacement. string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

State string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
TopicId Changes to this property will trigger replacement. string

The OCID of the topic for the subscription.

** 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 for the subscription.
createdTime String
The time when this suscription was created.
definedTags Map<String,String>
(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"}
deliveryPolicy String
The delivery policy of the subscription. Stored as a JSON string.
endpoint Changes to this property will trigger replacement. String

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

etag String
For optimistic concurrency control. See if-match.
freeformTags Map<String,String>
(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"}
protocol Changes to this property will trigger replacement. String

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

state String
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
topicId Changes to this property will trigger replacement. String

The OCID of the topic for the subscription.

** 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 for the subscription.
createdTime string
The time when this suscription was created.
definedTags {[key: string]: string}
(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"}
deliveryPolicy string
The delivery policy of the subscription. Stored as a JSON string.
endpoint Changes to this property will trigger replacement. string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

etag string
For optimistic concurrency control. See if-match.
freeformTags {[key: string]: string}
(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"}
protocol Changes to this property will trigger replacement. string

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

state string
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
topicId Changes to this property will trigger replacement. string

The OCID of the topic for the subscription.

** 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 for the subscription.
created_time str
The time when this suscription was created.
defined_tags Mapping[str, str]
(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"}
delivery_policy str
The delivery policy of the subscription. Stored as a JSON string.
endpoint Changes to this property will trigger replacement. str

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

etag str
For optimistic concurrency control. See if-match.
freeform_tags Mapping[str, str]
(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"}
protocol Changes to this property will trigger replacement. str

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

state str
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
topic_id Changes to this property will trigger replacement. str

The OCID of the topic for the subscription.

** 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 for the subscription.
createdTime String
The time when this suscription was created.
definedTags Map<String>
(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"}
deliveryPolicy String
The delivery policy of the subscription. Stored as a JSON string.
endpoint Changes to this property will trigger replacement. String

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

etag String
For optimistic concurrency control. See if-match.
freeformTags Map<String>
(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"}
protocol Changes to this property will trigger replacement. String

The protocol used for the subscription.

Allowed values:

  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • ORACLE_FUNCTIONS
  • PAGERDUTY
  • SLACK
  • SMS

For information about subscription protocols, see To create a subscription.

state String
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
topicId Changes to this property will trigger replacement. String

The OCID of the topic for the subscription.

** 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

Import

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

$ pulumi import oci:Ons/subscription:Subscription test_subscription "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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