oci.AnnouncementsService.AnnouncementSubscription
Explore with Pulumi AI
This resource provides the Announcement Subscription resource in Oracle Cloud Infrastructure Announcements Service service.
Creates a new announcement subscription.
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAnnouncementSubscription = new oci.announcementsservice.AnnouncementSubscription("test_announcement_subscription", {
    compartmentId: compartmentId,
    displayName: announcementSubscriptionDisplayName,
    onsTopicId: testNotificationTopic.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: announcementSubscriptionDescription,
    filterGroups: {
        filters: [{
            type: announcementSubscriptionFilterGroupsFiltersType,
            value: announcementSubscriptionFilterGroupsFiltersValue,
        }],
    },
    freeformTags: {
        "bar-key": "value",
    },
    preferredLanguage: announcementSubscriptionPreferredLanguage,
    preferredTimeZone: announcementSubscriptionPreferredTimeZone,
});
import pulumi
import pulumi_oci as oci
test_announcement_subscription = oci.announcements_service.AnnouncementSubscription("test_announcement_subscription",
    compartment_id=compartment_id,
    display_name=announcement_subscription_display_name,
    ons_topic_id=test_notification_topic["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=announcement_subscription_description,
    filter_groups={
        "filters": [{
            "type": announcement_subscription_filter_groups_filters_type,
            "value": announcement_subscription_filter_groups_filters_value,
        }],
    },
    freeform_tags={
        "bar-key": "value",
    },
    preferred_language=announcement_subscription_preferred_language,
    preferred_time_zone=announcement_subscription_preferred_time_zone)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/announcementsservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := announcementsservice.NewAnnouncementSubscription(ctx, "test_announcement_subscription", &announcementsservice.AnnouncementSubscriptionArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(announcementSubscriptionDisplayName),
			OnsTopicId:    pulumi.Any(testNotificationTopic.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(announcementSubscriptionDescription),
			FilterGroups: &announcementsservice.AnnouncementSubscriptionFilterGroupsArgs{
				Filters: announcementsservice.AnnouncementSubscriptionFilterGroupsFilterArray{
					&announcementsservice.AnnouncementSubscriptionFilterGroupsFilterArgs{
						Type:  pulumi.Any(announcementSubscriptionFilterGroupsFiltersType),
						Value: pulumi.Any(announcementSubscriptionFilterGroupsFiltersValue),
					},
				},
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			PreferredLanguage: pulumi.Any(announcementSubscriptionPreferredLanguage),
			PreferredTimeZone: pulumi.Any(announcementSubscriptionPreferredTimeZone),
		})
		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 testAnnouncementSubscription = new Oci.AnnouncementsService.AnnouncementSubscription("test_announcement_subscription", new()
    {
        CompartmentId = compartmentId,
        DisplayName = announcementSubscriptionDisplayName,
        OnsTopicId = testNotificationTopic.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = announcementSubscriptionDescription,
        FilterGroups = new Oci.AnnouncementsService.Inputs.AnnouncementSubscriptionFilterGroupsArgs
        {
            Filters = new[]
            {
                new Oci.AnnouncementsService.Inputs.AnnouncementSubscriptionFilterGroupsFilterArgs
                {
                    Type = announcementSubscriptionFilterGroupsFiltersType,
                    Value = announcementSubscriptionFilterGroupsFiltersValue,
                },
            },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        PreferredLanguage = announcementSubscriptionPreferredLanguage,
        PreferredTimeZone = announcementSubscriptionPreferredTimeZone,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AnnouncementsService.AnnouncementSubscription;
import com.pulumi.oci.AnnouncementsService.AnnouncementSubscriptionArgs;
import com.pulumi.oci.AnnouncementsService.inputs.AnnouncementSubscriptionFilterGroupsArgs;
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 testAnnouncementSubscription = new AnnouncementSubscription("testAnnouncementSubscription", AnnouncementSubscriptionArgs.builder()
            .compartmentId(compartmentId)
            .displayName(announcementSubscriptionDisplayName)
            .onsTopicId(testNotificationTopic.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(announcementSubscriptionDescription)
            .filterGroups(AnnouncementSubscriptionFilterGroupsArgs.builder()
                .filters(AnnouncementSubscriptionFilterGroupsFilterArgs.builder()
                    .type(announcementSubscriptionFilterGroupsFiltersType)
                    .value(announcementSubscriptionFilterGroupsFiltersValue)
                    .build())
                .build())
            .freeformTags(Map.of("bar-key", "value"))
            .preferredLanguage(announcementSubscriptionPreferredLanguage)
            .preferredTimeZone(announcementSubscriptionPreferredTimeZone)
            .build());
    }
}
resources:
  testAnnouncementSubscription:
    type: oci:AnnouncementsService:AnnouncementSubscription
    name: test_announcement_subscription
    properties:
      compartmentId: ${compartmentId}
      displayName: ${announcementSubscriptionDisplayName}
      onsTopicId: ${testNotificationTopic.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${announcementSubscriptionDescription}
      filterGroups:
        filters:
          - type: ${announcementSubscriptionFilterGroupsFiltersType}
            value: ${announcementSubscriptionFilterGroupsFiltersValue}
      freeformTags:
        bar-key: value
      preferredLanguage: ${announcementSubscriptionPreferredLanguage}
      preferredTimeZone: ${announcementSubscriptionPreferredTimeZone}
Create AnnouncementSubscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AnnouncementSubscription(name: string, args: AnnouncementSubscriptionArgs, opts?: CustomResourceOptions);@overload
def AnnouncementSubscription(resource_name: str,
                             args: AnnouncementSubscriptionArgs,
                             opts: Optional[ResourceOptions] = None)
@overload
def AnnouncementSubscription(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             compartment_id: Optional[str] = None,
                             display_name: Optional[str] = None,
                             ons_topic_id: Optional[str] = None,
                             defined_tags: Optional[Mapping[str, str]] = None,
                             description: Optional[str] = None,
                             filter_groups: Optional[AnnouncementSubscriptionFilterGroupsArgs] = None,
                             freeform_tags: Optional[Mapping[str, str]] = None,
                             preferred_language: Optional[str] = None,
                             preferred_time_zone: Optional[str] = None)func NewAnnouncementSubscription(ctx *Context, name string, args AnnouncementSubscriptionArgs, opts ...ResourceOption) (*AnnouncementSubscription, error)public AnnouncementSubscription(string name, AnnouncementSubscriptionArgs args, CustomResourceOptions? opts = null)
public AnnouncementSubscription(String name, AnnouncementSubscriptionArgs args)
public AnnouncementSubscription(String name, AnnouncementSubscriptionArgs args, CustomResourceOptions options)
type: oci:AnnouncementsService:AnnouncementSubscription
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 AnnouncementSubscriptionArgs
- 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 AnnouncementSubscriptionArgs
- 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 AnnouncementSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AnnouncementSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AnnouncementSubscriptionArgs
- 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 announcementSubscriptionResource = new Oci.AnnouncementsService.AnnouncementSubscription("announcementSubscriptionResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    OnsTopicId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FilterGroups = new Oci.AnnouncementsService.Inputs.AnnouncementSubscriptionFilterGroupsArgs
    {
        Filters = new[]
        {
            new Oci.AnnouncementsService.Inputs.AnnouncementSubscriptionFilterGroupsFilterArgs
            {
                Type = "string",
                Value = "string",
            },
        },
        Name = "string",
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    PreferredLanguage = "string",
    PreferredTimeZone = "string",
});
example, err := announcementsservice.NewAnnouncementSubscription(ctx, "announcementSubscriptionResource", &announcementsservice.AnnouncementSubscriptionArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	OnsTopicId:    pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FilterGroups: &announcementsservice.AnnouncementSubscriptionFilterGroupsArgs{
		Filters: announcementsservice.AnnouncementSubscriptionFilterGroupsFilterArray{
			&announcementsservice.AnnouncementSubscriptionFilterGroupsFilterArgs{
				Type:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
		Name: pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PreferredLanguage: pulumi.String("string"),
	PreferredTimeZone: pulumi.String("string"),
})
var announcementSubscriptionResource = new AnnouncementSubscription("announcementSubscriptionResource", AnnouncementSubscriptionArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .onsTopicId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .filterGroups(AnnouncementSubscriptionFilterGroupsArgs.builder()
        .filters(AnnouncementSubscriptionFilterGroupsFilterArgs.builder()
            .type("string")
            .value("string")
            .build())
        .name("string")
        .build())
    .freeformTags(Map.of("string", "string"))
    .preferredLanguage("string")
    .preferredTimeZone("string")
    .build());
announcement_subscription_resource = oci.announcements_service.AnnouncementSubscription("announcementSubscriptionResource",
    compartment_id="string",
    display_name="string",
    ons_topic_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    filter_groups={
        "filters": [{
            "type": "string",
            "value": "string",
        }],
        "name": "string",
    },
    freeform_tags={
        "string": "string",
    },
    preferred_language="string",
    preferred_time_zone="string")
const announcementSubscriptionResource = new oci.announcementsservice.AnnouncementSubscription("announcementSubscriptionResource", {
    compartmentId: "string",
    displayName: "string",
    onsTopicId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    filterGroups: {
        filters: [{
            type: "string",
            value: "string",
        }],
        name: "string",
    },
    freeformTags: {
        string: "string",
    },
    preferredLanguage: "string",
    preferredTimeZone: "string",
});
type: oci:AnnouncementsService:AnnouncementSubscription
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    filterGroups:
        filters:
            - type: string
              value: string
        name: string
    freeformTags:
        string: string
    onsTopicId: string
    preferredLanguage: string
    preferredTimeZone: string
AnnouncementSubscription 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 AnnouncementSubscription resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- DisplayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- OnsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- FilterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- PreferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- PreferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 where you want to create the announcement subscription.
- DisplayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- OnsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- FilterGroups AnnouncementSubscription Filter Groups Args 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- PreferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- PreferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 where you want to create the announcement subscription.
- displayName String
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- onsTopic StringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- filterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- preferredLanguage String
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime StringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 where you want to create the announcement subscription.
- displayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- onsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- filterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- preferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 where you want to create the announcement subscription.
- display_name str
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- ons_topic_ strid 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- filter_groups AnnouncementSubscription Filter Groups Args 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- preferred_language str
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferred_time_ strzone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 where you want to create the announcement subscription.
- displayName String
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- onsTopic StringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- filterGroups Property Map
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- preferredLanguage String
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime StringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
Outputs
All input properties are implicitly available as output properties. Additionally, the AnnouncementSubscription resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- State string
- The current lifecycle state of the announcement subscription.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- State string
- The current lifecycle state of the announcement subscription.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- state String
- The current lifecycle state of the announcement subscription.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- state string
- The current lifecycle state of the announcement subscription.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- state str
- The current lifecycle state of the announcement subscription.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- time_updated str
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- state String
- The current lifecycle state of the announcement subscription.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
Look up Existing AnnouncementSubscription Resource
Get an existing AnnouncementSubscription 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?: AnnouncementSubscriptionState, opts?: CustomResourceOptions): AnnouncementSubscription@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        filter_groups: Optional[AnnouncementSubscriptionFilterGroupsArgs] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        ons_topic_id: Optional[str] = None,
        preferred_language: Optional[str] = None,
        preferred_time_zone: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> AnnouncementSubscriptionfunc GetAnnouncementSubscription(ctx *Context, name string, id IDInput, state *AnnouncementSubscriptionState, opts ...ResourceOption) (*AnnouncementSubscription, error)public static AnnouncementSubscription Get(string name, Input<string> id, AnnouncementSubscriptionState? state, CustomResourceOptions? opts = null)public static AnnouncementSubscription get(String name, Output<String> id, AnnouncementSubscriptionState state, CustomResourceOptions options)resources:  _:    type: oci:AnnouncementsService:AnnouncementSubscription    get:      id: ${id}- 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.
- CompartmentId string
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- DisplayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- FilterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- LifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- OnsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- PreferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- PreferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- State string
- The current lifecycle state of the announcement subscription.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- CompartmentId string
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- DisplayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- FilterGroups AnnouncementSubscription Filter Groups Args 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- LifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- OnsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- PreferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- PreferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- State string
- The current lifecycle state of the announcement subscription.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- compartmentId String
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- displayName String
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails String
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- onsTopic StringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- preferredLanguage String
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime StringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- state String
- The current lifecycle state of the announcement subscription.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- compartmentId string
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- displayName string
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filterGroups AnnouncementSubscription Filter Groups 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails string
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- onsTopic stringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- preferredLanguage string
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime stringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- state string
- The current lifecycle state of the announcement subscription.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated string
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- compartment_id str
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- display_name str
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filter_groups AnnouncementSubscription Filter Groups Args 
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycle_details str
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- ons_topic_ strid 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- preferred_language str
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferred_time_ strzone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- state str
- The current lifecycle state of the announcement subscription.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- time_updated str
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
- compartmentId String
- (Updatable) The OCID of the compartment where you want to create the announcement subscription.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A description of the announcement subscription. Avoid entering confidential information.
- displayName String
- (Updatable) A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filterGroups Property Map
- A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails String
- A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
- onsTopic StringId 
- (Updatable) The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.
- preferredLanguage String
- (Updatable) (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- preferredTime StringZone 
- (Updatable) The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles - ** 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 
- state String
- The current lifecycle state of the announcement subscription.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.
Supporting Types
AnnouncementSubscriptionFilterGroups, AnnouncementSubscriptionFilterGroupsArgs        
- Filters
List<AnnouncementSubscription Filter Groups Filter> 
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- Name string
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
- Filters
[]AnnouncementSubscription Filter Groups Filter 
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- Name string
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
- filters
List<AnnouncementSubscription Filter Groups Filter> 
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- name String
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
- filters
AnnouncementSubscription Filter Groups Filter[] 
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- name string
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
- filters
Sequence[AnnouncementSubscription Filter Groups Filter] 
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- name str
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
- filters List<Property Map>
- A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
- name String
- The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
AnnouncementSubscriptionFilterGroupsFilter, AnnouncementSubscriptionFilterGroupsFilterArgs          
Import
AnnouncementSubscriptions can be imported using the id, e.g.
$ pulumi import oci:AnnouncementsService/announcementSubscription:AnnouncementSubscription test_announcement_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.