Docs
Packagesoci.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("testSubscription", {
compartmentId: _var.compartment_id,
endpoint: _var.subscription_endpoint,
protocol: _var.subscription_protocol,
topicId: oci_ons_notification_topic.test_notification_topic.id,
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_subscription = oci.ons.Subscription("testSubscription",
compartment_id=var["compartment_id"],
endpoint=var["subscription_endpoint"],
protocol=var["subscription_protocol"],
topic_id=oci_ons_notification_topic["test_notification_topic"]["id"],
defined_tags={
"Operations.CostCenter": "42",
},
freeform_tags={
"Department": "Finance",
})
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.NewSubscription(ctx, "testSubscription", &Ons.SubscriptionArgs{
CompartmentId: pulumi.Any(_var.Compartment_id),
Endpoint: pulumi.Any(_var.Subscription_endpoint),
Protocol: pulumi.Any(_var.Subscription_protocol),
TopicId: pulumi.Any(oci_ons_notification_topic.Test_notification_topic.Id),
DefinedTags: pulumi.Map{
"Operations.CostCenter": pulumi.Any("42"),
},
FreeformTags: pulumi.Map{
"Department": pulumi.Any("Finance"),
},
})
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 testSubscription = new Oci.Ons.Subscription("testSubscription", new()
{
CompartmentId = @var.Compartment_id,
Endpoint = @var.Subscription_endpoint,
Protocol = @var.Subscription_protocol,
TopicId = oci_ons_notification_topic.Test_notification_topic.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
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(var_.compartment_id())
.endpoint(var_.subscription_endpoint())
.protocol(var_.subscription_protocol())
.topicId(oci_ons_notification_topic.test_notification_topic().id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testSubscription:
type: oci:Ons:Subscription
properties:
#Required
compartmentId: ${var.compartment_id}
endpoint: ${var.subscription_endpoint}
protocol: ${var.subscription_protocol}
topicId: ${oci_ons_notification_topic.test_notification_topic.id}
#Optional
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
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, Any]] = None,
delivery_policy: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = 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 string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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", "any" },
},
DeliveryPolicy = "string",
FreeformTags =
{
{ "string", "any" },
},
});
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.Map{
"string": pulumi.Any("any"),
},
DeliveryPolicy: pulumi.String("string"),
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
})
var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
.compartmentId("string")
.endpoint("string")
.protocol("string")
.topicId("string")
.definedTags(Map.of("string", "any"))
.deliveryPolicy("string")
.freeformTags(Map.of("string", "any"))
.build());
subscription_resource = oci.ons.Subscription("subscriptionResource",
compartment_id="string",
endpoint="string",
protocol="string",
topic_id="string",
defined_tags={
"string": "any",
},
delivery_policy="string",
freeform_tags={
"string": "any",
})
const subscriptionResource = new oci.ons.Subscription("subscriptionResource", {
compartmentId: "string",
endpoint: "string",
protocol: "string",
topicId: "string",
definedTags: {
string: "any",
},
deliveryPolicy: "string",
freeformTags: {
string: "any",
},
});
type: oci:Ons:Subscription
properties:
compartmentId: string
definedTags:
string: any
deliveryPolicy: string
endpoint: string
freeformTags:
string: any
protocol: string
topicId: string
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
The Subscription resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment for the subscription.
- Endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 string
The protocol used for the subscription.
Allowed values:
- Topic
Id 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
- Dictionary<string, object>
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- Dictionary<string, object>
- (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 string - (Updatable) The OCID of the compartment for the subscription.
- Endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 string
The protocol used for the subscription.
Allowed values:
- Topic
Id 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
- map[string]interface{}
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- map[string]interface{}
- (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 String - (Updatable) The OCID of the compartment for the subscription.
- endpoint String
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 String
The protocol used for the subscription.
Allowed values:
- topic
Id 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
- Map<String,Object>
- (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 String - The delivery policy of the subscription. Stored as a JSON string.
- Map<String,Object>
- (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 string - (Updatable) The OCID of the compartment for the subscription.
- endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 string
The protocol used for the subscription.
Allowed values:
- topic
Id 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
- {[key: string]: any}
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- {[key: string]: any}
- (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 str - (Updatable) The OCID of the compartment for the subscription.
- endpoint str
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 str
The protocol used for the subscription.
Allowed values:
- topic_
id 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
- Mapping[str, Any]
- (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.
- Mapping[str, Any]
- (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 String - (Updatable) The OCID of the compartment for the subscription.
- endpoint String
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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 String
The protocol used for the subscription.
Allowed values:
- topic
Id 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
- Map<Any>
- (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 String - The delivery policy of the subscription. Stored as a JSON string.
- Map<Any>
- (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:
- Created
Time 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 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 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 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.
- created
Time 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, Any]] = None,
delivery_policy: Optional[str] = None,
endpoint: Optional[str] = None,
etag: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
protocol: Optional[str] = None,
state: Optional[str] = None,
topic_id: Optional[str] = None) -> Subscriptionfunc 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)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Compartment
Id string - (Updatable) The OCID of the compartment for the subscription.
- Created
Time string - The time when this suscription was created.
- Dictionary<string, object>
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- Endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - Dictionary<string, object>
- (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 string
The protocol used for the subscription.
Allowed values:
- State string
- The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
- Topic
Id 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 string - (Updatable) The OCID of the compartment for the subscription.
- Created
Time string - The time when this suscription was created.
- map[string]interface{}
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- Endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - map[string]interface{}
- (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 string
The protocol used for the subscription.
Allowed values:
- State string
- The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
- Topic
Id 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 String - (Updatable) The OCID of the compartment for the subscription.
- created
Time String - The time when this suscription was created.
- Map<String,Object>
- (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 String - The delivery policy of the subscription. Stored as a JSON string.
- endpoint String
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - Map<String,Object>
- (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 String
The protocol used for the subscription.
Allowed values:
- state String
- The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
- topic
Id 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 string - (Updatable) The OCID of the compartment for the subscription.
- created
Time string - The time when this suscription was created.
- {[key: string]: any}
- (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 string - The delivery policy of the subscription. Stored as a JSON string.
- endpoint string
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - {[key: string]: any}
- (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 string
The protocol used for the subscription.
Allowed values:
- state string
- The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
- topic
Id 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.
- Mapping[str, Any]
- (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 str
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - Mapping[str, Any]
- (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 str
The protocol used for the subscription.
Allowed values:
- 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 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
- compartment
Id String - (Updatable) The OCID of the compartment for the subscription.
- created
Time String - The time when this suscription was created.
- Map<Any>
- (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 String - The delivery policy of the subscription. Stored as a JSON string.
- endpoint String
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the
EMAILprotocol, 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. - Map<Any>
- (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 String
The protocol used for the subscription.
Allowed values:
- state String
- The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
- topic
Id 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"
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
ociTerraform Provider.