1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AnnouncementsService
  5. getAnnouncementSubscription
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.AnnouncementsService.getAnnouncementSubscription

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    This data source provides details about a specific Announcement Subscription resource in Oracle Cloud Infrastructure Announcements Service service.

    Gets the specified 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 = oci.AnnouncementsService.getAnnouncementSubscription({
        announcementSubscriptionId: testAnnouncementSubscriptionOciAnnouncementsServiceAnnouncementSubscription.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_announcement_subscription = oci.AnnouncementsService.get_announcement_subscription(announcement_subscription_id=test_announcement_subscription_oci_announcements_service_announcement_subscription["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/AnnouncementsService"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := AnnouncementsService.GetAnnouncementSubscription(ctx, &announcementsservice.GetAnnouncementSubscriptionArgs{
    			AnnouncementSubscriptionId: testAnnouncementSubscriptionOciAnnouncementsServiceAnnouncementSubscription.Id,
    		}, nil)
    		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 = Oci.AnnouncementsService.GetAnnouncementSubscription.Invoke(new()
        {
            AnnouncementSubscriptionId = testAnnouncementSubscriptionOciAnnouncementsServiceAnnouncementSubscription.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.AnnouncementsService.AnnouncementsServiceFunctions;
    import com.pulumi.oci.AnnouncementsService.inputs.GetAnnouncementSubscriptionArgs;
    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) {
            final var testAnnouncementSubscription = AnnouncementsServiceFunctions.getAnnouncementSubscription(GetAnnouncementSubscriptionArgs.builder()
                .announcementSubscriptionId(testAnnouncementSubscriptionOciAnnouncementsServiceAnnouncementSubscription.id())
                .build());
    
        }
    }
    
    variables:
      testAnnouncementSubscription:
        fn::invoke:
          Function: oci:AnnouncementsService:getAnnouncementSubscription
          Arguments:
            announcementSubscriptionId: ${testAnnouncementSubscriptionOciAnnouncementsServiceAnnouncementSubscription.id}
    

    Using getAnnouncementSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAnnouncementSubscription(args: GetAnnouncementSubscriptionArgs, opts?: InvokeOptions): Promise<GetAnnouncementSubscriptionResult>
    function getAnnouncementSubscriptionOutput(args: GetAnnouncementSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetAnnouncementSubscriptionResult>
    def get_announcement_subscription(announcement_subscription_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetAnnouncementSubscriptionResult
    def get_announcement_subscription_output(announcement_subscription_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetAnnouncementSubscriptionResult]
    func GetAnnouncementSubscription(ctx *Context, args *GetAnnouncementSubscriptionArgs, opts ...InvokeOption) (*GetAnnouncementSubscriptionResult, error)
    func GetAnnouncementSubscriptionOutput(ctx *Context, args *GetAnnouncementSubscriptionOutputArgs, opts ...InvokeOption) GetAnnouncementSubscriptionResultOutput

    > Note: This function is named GetAnnouncementSubscription in the Go SDK.

    public static class GetAnnouncementSubscription 
    {
        public static Task<GetAnnouncementSubscriptionResult> InvokeAsync(GetAnnouncementSubscriptionArgs args, InvokeOptions? opts = null)
        public static Output<GetAnnouncementSubscriptionResult> Invoke(GetAnnouncementSubscriptionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAnnouncementSubscriptionResult> getAnnouncementSubscription(GetAnnouncementSubscriptionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:AnnouncementsService/getAnnouncementSubscription:getAnnouncementSubscription
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AnnouncementSubscriptionId string
    The OCID of the announcement subscription.
    AnnouncementSubscriptionId string
    The OCID of the announcement subscription.
    announcementSubscriptionId String
    The OCID of the announcement subscription.
    announcementSubscriptionId string
    The OCID of the announcement subscription.
    announcement_subscription_id str
    The OCID of the announcement subscription.
    announcementSubscriptionId String
    The OCID of the announcement subscription.

    getAnnouncementSubscription Result

    The following output properties are available:

    AnnouncementSubscriptionId string
    CompartmentId string
    The OCID of the compartment that contains the announcement subscription.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description of the announcement subscription. Avoid entering confidential information.
    DisplayName string
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FilterGroups List<GetAnnouncementSubscriptionFilterGroup>
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the announcement subscription.
    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.
    OnsTopicId string
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    PreferredLanguage string
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    PreferredTimeZone string
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    State string
    The current lifecycle state of the announcement subscription.
    SystemTags Dictionary<string, object>
    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.
    AnnouncementSubscriptionId string
    CompartmentId string
    The OCID of the compartment that contains the announcement subscription.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description of the announcement subscription. Avoid entering confidential information.
    DisplayName string
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FilterGroups []GetAnnouncementSubscriptionFilterGroup
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the announcement subscription.
    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.
    OnsTopicId string
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    PreferredLanguage string
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    PreferredTimeZone string
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    State string
    The current lifecycle state of the announcement subscription.
    SystemTags map[string]interface{}
    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.
    announcementSubscriptionId String
    compartmentId String
    The OCID of the compartment that contains the announcement subscription.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description of the announcement subscription. Avoid entering confidential information.
    displayName String
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filterGroups List<GetAnnouncementSubscriptionFilterGroup>
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the announcement subscription.
    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.
    onsTopicId String
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    preferredLanguage String
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    preferredTimeZone String
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    state String
    The current lifecycle state of the announcement subscription.
    systemTags Map<String,Object>
    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.
    announcementSubscriptionId string
    compartmentId string
    The OCID of the compartment that contains the announcement subscription.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    A description of the announcement subscription. Avoid entering confidential information.
    displayName string
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filterGroups GetAnnouncementSubscriptionFilterGroup[]
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the announcement subscription.
    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.
    onsTopicId string
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    preferredLanguage string
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    preferredTimeZone string
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    state string
    The current lifecycle state of the announcement subscription.
    systemTags {[key: string]: any}
    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.
    announcement_subscription_id str
    compartment_id str
    The OCID of the compartment that contains the announcement subscription.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    A description of the announcement subscription. Avoid entering confidential information.
    display_name str
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filter_groups Sequence[announcementsservice.GetAnnouncementSubscriptionFilterGroup]
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the announcement subscription.
    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_id str
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    preferred_language str
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    preferred_time_zone str
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    state str
    The current lifecycle state of the announcement subscription.
    system_tags Mapping[str, Any]
    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.
    announcementSubscriptionId String
    compartmentId String
    The OCID of the compartment that contains the announcement subscription.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description of the announcement subscription. Avoid entering confidential information.
    displayName String
    A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filterGroups List<Property Map>
    A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the announcement subscription.
    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.
    onsTopicId String
    The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
    preferredLanguage String
    (For announcement subscriptions with Oracle Fusion Applications configured as the service only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the language tag format (x-obmcs-human-language). For example fr-FR.
    preferredTimeZone String
    The time zone that the user prefers for announcement time stamps. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example America/Los_Angeles.
    state String
    The current lifecycle state of the announcement subscription.
    systemTags Map<Any>
    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

    GetAnnouncementSubscriptionFilterGroup

    Filters List<GetAnnouncementSubscriptionFilterGroupFilter>
    A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    Name string
    The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
    Filters []GetAnnouncementSubscriptionFilterGroupFilter
    A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    Name string
    The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
    filters List<GetAnnouncementSubscriptionFilterGroupFilter>
    A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    name String
    The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
    filters GetAnnouncementSubscriptionFilterGroupFilter[]
    A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    name string
    The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
    filters Sequence[announcementsservice.GetAnnouncementSubscriptionFilterGroupFilter]
    A list of filters against which the Announcements service matches announcements. You cannot have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    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 have more than one of any given filter type within a filter group. You also cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group.
    name String
    The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.

    GetAnnouncementSubscriptionFilterGroupFilter

    Type string
    The type of filter.
    Value string
    The value of the filter.
    Type string
    The type of filter.
    Value string
    The value of the filter.
    type String
    The type of filter.
    value String
    The value of the filter.
    type string
    The type of filter.
    value string
    The value of the filter.
    type str
    The type of filter.
    value str
    The value of the filter.
    type String
    The type of filter.
    value String
    The value of the filter.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi