1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opsi
  5. NewsReport
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Opsi.NewsReport

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This resource provides the News Report resource in Oracle Cloud Infrastructure Opsi service.

    Create a news report in Ops Insights. The report will be enabled in Ops Insights. Insights will be emailed as per selected frequency.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testNewsReport = new oci.opsi.NewsReport("test_news_report", {
        compartmentId: compartmentId,
        contentTypes: {
            capacityPlanningResources: newsReportContentTypesCapacityPlanningResources,
            sqlInsightsFleetAnalysisResources: newsReportContentTypesSqlInsightsFleetAnalysisResources,
            sqlInsightsPerformanceDegradationResources: newsReportContentTypesSqlInsightsPerformanceDegradationResources,
            sqlInsightsPlanChangesResources: newsReportContentTypesSqlInsightsPlanChangesResources,
            sqlInsightsTopDatabasesResources: newsReportContentTypesSqlInsightsTopDatabasesResources,
            sqlInsightsTopSqlByInsightsResources: newsReportContentTypesSqlInsightsTopSqlByInsightsResources,
            sqlInsightsTopSqlResources: newsReportContentTypesSqlInsightsTopSqlResources,
        },
        description: newsReportDescription,
        locale: newsReportLocale,
        name: newsReportName,
        newsFrequency: newsReportNewsFrequency,
        onsTopicId: testOnsTopic.id,
        areChildCompartmentsIncluded: newsReportAreChildCompartmentsIncluded,
        dayOfWeek: newsReportDayOfWeek,
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        freeformTags: {
            "bar-key": "value",
        },
        status: newsReportStatus,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_news_report = oci.opsi.NewsReport("test_news_report",
        compartment_id=compartment_id,
        content_types={
            "capacity_planning_resources": news_report_content_types_capacity_planning_resources,
            "sql_insights_fleet_analysis_resources": news_report_content_types_sql_insights_fleet_analysis_resources,
            "sql_insights_performance_degradation_resources": news_report_content_types_sql_insights_performance_degradation_resources,
            "sql_insights_plan_changes_resources": news_report_content_types_sql_insights_plan_changes_resources,
            "sql_insights_top_databases_resources": news_report_content_types_sql_insights_top_databases_resources,
            "sql_insights_top_sql_by_insights_resources": news_report_content_types_sql_insights_top_sql_by_insights_resources,
            "sql_insights_top_sql_resources": news_report_content_types_sql_insights_top_sql_resources,
        },
        description=news_report_description,
        locale=news_report_locale,
        name=news_report_name,
        news_frequency=news_report_news_frequency,
        ons_topic_id=test_ons_topic["id"],
        are_child_compartments_included=news_report_are_child_compartments_included,
        day_of_week=news_report_day_of_week,
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        freeform_tags={
            "bar-key": "value",
        },
        status=news_report_status)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Opsi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Opsi.NewNewsReport(ctx, "test_news_report", &Opsi.NewsReportArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			ContentTypes: &opsi.NewsReportContentTypesArgs{
    				CapacityPlanningResources:                  pulumi.Any(newsReportContentTypesCapacityPlanningResources),
    				SqlInsightsFleetAnalysisResources:          pulumi.Any(newsReportContentTypesSqlInsightsFleetAnalysisResources),
    				SqlInsightsPerformanceDegradationResources: pulumi.Any(newsReportContentTypesSqlInsightsPerformanceDegradationResources),
    				SqlInsightsPlanChangesResources:            pulumi.Any(newsReportContentTypesSqlInsightsPlanChangesResources),
    				SqlInsightsTopDatabasesResources:           pulumi.Any(newsReportContentTypesSqlInsightsTopDatabasesResources),
    				SqlInsightsTopSqlByInsightsResources:       pulumi.Any(newsReportContentTypesSqlInsightsTopSqlByInsightsResources),
    				SqlInsightsTopSqlResources:                 pulumi.Any(newsReportContentTypesSqlInsightsTopSqlResources),
    			},
    			Description:                  pulumi.Any(newsReportDescription),
    			Locale:                       pulumi.Any(newsReportLocale),
    			Name:                         pulumi.Any(newsReportName),
    			NewsFrequency:                pulumi.Any(newsReportNewsFrequency),
    			OnsTopicId:                   pulumi.Any(testOnsTopic.Id),
    			AreChildCompartmentsIncluded: pulumi.Any(newsReportAreChildCompartmentsIncluded),
    			DayOfWeek:                    pulumi.Any(newsReportDayOfWeek),
    			DefinedTags: pulumi.StringMap{
    				"foo-namespace.bar-key": pulumi.String("value"),
    			},
    			FreeformTags: pulumi.StringMap{
    				"bar-key": pulumi.String("value"),
    			},
    			Status: pulumi.Any(newsReportStatus),
    		})
    		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 testNewsReport = new Oci.Opsi.NewsReport("test_news_report", new()
        {
            CompartmentId = compartmentId,
            ContentTypes = new Oci.Opsi.Inputs.NewsReportContentTypesArgs
            {
                CapacityPlanningResources = newsReportContentTypesCapacityPlanningResources,
                SqlInsightsFleetAnalysisResources = newsReportContentTypesSqlInsightsFleetAnalysisResources,
                SqlInsightsPerformanceDegradationResources = newsReportContentTypesSqlInsightsPerformanceDegradationResources,
                SqlInsightsPlanChangesResources = newsReportContentTypesSqlInsightsPlanChangesResources,
                SqlInsightsTopDatabasesResources = newsReportContentTypesSqlInsightsTopDatabasesResources,
                SqlInsightsTopSqlByInsightsResources = newsReportContentTypesSqlInsightsTopSqlByInsightsResources,
                SqlInsightsTopSqlResources = newsReportContentTypesSqlInsightsTopSqlResources,
            },
            Description = newsReportDescription,
            Locale = newsReportLocale,
            Name = newsReportName,
            NewsFrequency = newsReportNewsFrequency,
            OnsTopicId = testOnsTopic.Id,
            AreChildCompartmentsIncluded = newsReportAreChildCompartmentsIncluded,
            DayOfWeek = newsReportDayOfWeek,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            Status = newsReportStatus,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Opsi.NewsReport;
    import com.pulumi.oci.Opsi.NewsReportArgs;
    import com.pulumi.oci.Opsi.inputs.NewsReportContentTypesArgs;
    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 testNewsReport = new NewsReport("testNewsReport", NewsReportArgs.builder()
                .compartmentId(compartmentId)
                .contentTypes(NewsReportContentTypesArgs.builder()
                    .capacityPlanningResources(newsReportContentTypesCapacityPlanningResources)
                    .sqlInsightsFleetAnalysisResources(newsReportContentTypesSqlInsightsFleetAnalysisResources)
                    .sqlInsightsPerformanceDegradationResources(newsReportContentTypesSqlInsightsPerformanceDegradationResources)
                    .sqlInsightsPlanChangesResources(newsReportContentTypesSqlInsightsPlanChangesResources)
                    .sqlInsightsTopDatabasesResources(newsReportContentTypesSqlInsightsTopDatabasesResources)
                    .sqlInsightsTopSqlByInsightsResources(newsReportContentTypesSqlInsightsTopSqlByInsightsResources)
                    .sqlInsightsTopSqlResources(newsReportContentTypesSqlInsightsTopSqlResources)
                    .build())
                .description(newsReportDescription)
                .locale(newsReportLocale)
                .name(newsReportName)
                .newsFrequency(newsReportNewsFrequency)
                .onsTopicId(testOnsTopic.id())
                .areChildCompartmentsIncluded(newsReportAreChildCompartmentsIncluded)
                .dayOfWeek(newsReportDayOfWeek)
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .freeformTags(Map.of("bar-key", "value"))
                .status(newsReportStatus)
                .build());
    
        }
    }
    
    resources:
      testNewsReport:
        type: oci:Opsi:NewsReport
        name: test_news_report
        properties:
          compartmentId: ${compartmentId}
          contentTypes:
            capacityPlanningResources: ${newsReportContentTypesCapacityPlanningResources}
            sqlInsightsFleetAnalysisResources: ${newsReportContentTypesSqlInsightsFleetAnalysisResources}
            sqlInsightsPerformanceDegradationResources: ${newsReportContentTypesSqlInsightsPerformanceDegradationResources}
            sqlInsightsPlanChangesResources: ${newsReportContentTypesSqlInsightsPlanChangesResources}
            sqlInsightsTopDatabasesResources: ${newsReportContentTypesSqlInsightsTopDatabasesResources}
            sqlInsightsTopSqlByInsightsResources: ${newsReportContentTypesSqlInsightsTopSqlByInsightsResources}
            sqlInsightsTopSqlResources: ${newsReportContentTypesSqlInsightsTopSqlResources}
          description: ${newsReportDescription}
          locale: ${newsReportLocale}
          name: ${newsReportName}
          newsFrequency: ${newsReportNewsFrequency}
          onsTopicId: ${testOnsTopic.id}
          areChildCompartmentsIncluded: ${newsReportAreChildCompartmentsIncluded}
          dayOfWeek: ${newsReportDayOfWeek}
          definedTags:
            foo-namespace.bar-key: value
          freeformTags:
            bar-key: value
          status: ${newsReportStatus}
    

    Create NewsReport Resource

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

    Constructor syntax

    new NewsReport(name: string, args: NewsReportArgs, opts?: CustomResourceOptions);
    @overload
    def NewsReport(resource_name: str,
                   args: NewsReportArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def NewsReport(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   compartment_id: Optional[str] = None,
                   content_types: Optional[_opsi.NewsReportContentTypesArgs] = None,
                   description: Optional[str] = None,
                   locale: Optional[str] = None,
                   news_frequency: Optional[str] = None,
                   ons_topic_id: Optional[str] = None,
                   are_child_compartments_included: Optional[bool] = None,
                   day_of_week: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None,
                   status: Optional[str] = None)
    func NewNewsReport(ctx *Context, name string, args NewsReportArgs, opts ...ResourceOption) (*NewsReport, error)
    public NewsReport(string name, NewsReportArgs args, CustomResourceOptions? opts = null)
    public NewsReport(String name, NewsReportArgs args)
    public NewsReport(String name, NewsReportArgs args, CustomResourceOptions options)
    
    type: oci:Opsi:NewsReport
    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 NewsReportArgs
    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 NewsReportArgs
    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 NewsReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NewsReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NewsReportArgs
    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 newsReportResource = new Oci.Opsi.NewsReport("newsReportResource", new()
    {
        CompartmentId = "string",
        ContentTypes = new Oci.Opsi.Inputs.NewsReportContentTypesArgs
        {
            CapacityPlanningResources = new[]
            {
                "string",
            },
            SqlInsightsFleetAnalysisResources = new[]
            {
                "string",
            },
            SqlInsightsPerformanceDegradationResources = new[]
            {
                "string",
            },
            SqlInsightsPlanChangesResources = new[]
            {
                "string",
            },
            SqlInsightsTopDatabasesResources = new[]
            {
                "string",
            },
            SqlInsightsTopSqlByInsightsResources = new[]
            {
                "string",
            },
            SqlInsightsTopSqlResources = new[]
            {
                "string",
            },
        },
        Description = "string",
        Locale = "string",
        NewsFrequency = "string",
        OnsTopicId = "string",
        AreChildCompartmentsIncluded = false,
        DayOfWeek = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        FreeformTags = 
        {
            { "string", "string" },
        },
        Name = "string",
        Status = "string",
    });
    
    example, err := Opsi.NewNewsReport(ctx, "newsReportResource", &Opsi.NewsReportArgs{
    	CompartmentId: pulumi.String("string"),
    	ContentTypes: &opsi.NewsReportContentTypesArgs{
    		CapacityPlanningResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsFleetAnalysisResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsPerformanceDegradationResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsPlanChangesResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsTopDatabasesResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsTopSqlByInsightsResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SqlInsightsTopSqlResources: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Description:                  pulumi.String("string"),
    	Locale:                       pulumi.String("string"),
    	NewsFrequency:                pulumi.String("string"),
    	OnsTopicId:                   pulumi.String("string"),
    	AreChildCompartmentsIncluded: pulumi.Bool(false),
    	DayOfWeek:                    pulumi.String("string"),
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:   pulumi.String("string"),
    	Status: pulumi.String("string"),
    })
    
    var newsReportResource = new NewsReport("newsReportResource", NewsReportArgs.builder()
        .compartmentId("string")
        .contentTypes(NewsReportContentTypesArgs.builder()
            .capacityPlanningResources("string")
            .sqlInsightsFleetAnalysisResources("string")
            .sqlInsightsPerformanceDegradationResources("string")
            .sqlInsightsPlanChangesResources("string")
            .sqlInsightsTopDatabasesResources("string")
            .sqlInsightsTopSqlByInsightsResources("string")
            .sqlInsightsTopSqlResources("string")
            .build())
        .description("string")
        .locale("string")
        .newsFrequency("string")
        .onsTopicId("string")
        .areChildCompartmentsIncluded(false)
        .dayOfWeek("string")
        .definedTags(Map.of("string", "string"))
        .freeformTags(Map.of("string", "string"))
        .name("string")
        .status("string")
        .build());
    
    news_report_resource = oci.opsi.NewsReport("newsReportResource",
        compartment_id="string",
        content_types={
            "capacity_planning_resources": ["string"],
            "sql_insights_fleet_analysis_resources": ["string"],
            "sql_insights_performance_degradation_resources": ["string"],
            "sql_insights_plan_changes_resources": ["string"],
            "sql_insights_top_databases_resources": ["string"],
            "sql_insights_top_sql_by_insights_resources": ["string"],
            "sql_insights_top_sql_resources": ["string"],
        },
        description="string",
        locale="string",
        news_frequency="string",
        ons_topic_id="string",
        are_child_compartments_included=False,
        day_of_week="string",
        defined_tags={
            "string": "string",
        },
        freeform_tags={
            "string": "string",
        },
        name="string",
        status="string")
    
    const newsReportResource = new oci.opsi.NewsReport("newsReportResource", {
        compartmentId: "string",
        contentTypes: {
            capacityPlanningResources: ["string"],
            sqlInsightsFleetAnalysisResources: ["string"],
            sqlInsightsPerformanceDegradationResources: ["string"],
            sqlInsightsPlanChangesResources: ["string"],
            sqlInsightsTopDatabasesResources: ["string"],
            sqlInsightsTopSqlByInsightsResources: ["string"],
            sqlInsightsTopSqlResources: ["string"],
        },
        description: "string",
        locale: "string",
        newsFrequency: "string",
        onsTopicId: "string",
        areChildCompartmentsIncluded: false,
        dayOfWeek: "string",
        definedTags: {
            string: "string",
        },
        freeformTags: {
            string: "string",
        },
        name: "string",
        status: "string",
    });
    
    type: oci:Opsi:NewsReport
    properties:
        areChildCompartmentsIncluded: false
        compartmentId: string
        contentTypes:
            capacityPlanningResources:
                - string
            sqlInsightsFleetAnalysisResources:
                - string
            sqlInsightsPerformanceDegradationResources:
                - string
            sqlInsightsPlanChangesResources:
                - string
            sqlInsightsTopDatabasesResources:
                - string
            sqlInsightsTopSqlByInsightsResources:
                - string
            sqlInsightsTopSqlResources:
                - string
        dayOfWeek: string
        definedTags:
            string: string
        description: string
        freeformTags:
            string: string
        locale: string
        name: string
        newsFrequency: string
        onsTopicId: string
        status: string
    

    NewsReport 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 NewsReport resource accepts the following input properties:

    CompartmentId string
    (Updatable) Compartment Identifier where the news report will be created.
    ContentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    Description string
    (Updatable) The description of the news report.
    Locale string
    (Updatable) Language of the news report.
    NewsFrequency string
    (Updatable) News report frequency.
    OnsTopicId string
    (Updatable) The OCID of the ONS topic.
    AreChildCompartmentsIncluded bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    DayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags 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"}
    Name string
    (Updatable) The news report name.
    Status string

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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) Compartment Identifier where the news report will be created.
    ContentTypes NewsReportContentTypesArgs
    (Updatable) Content types that the news report can handle.
    Description string
    (Updatable) The description of the news report.
    Locale string
    (Updatable) Language of the news report.
    NewsFrequency string
    (Updatable) News report frequency.
    OnsTopicId string
    (Updatable) The OCID of the ONS topic.
    AreChildCompartmentsIncluded bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    DayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags 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"}
    Name string
    (Updatable) The news report name.
    Status string

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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) Compartment Identifier where the news report will be created.
    contentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    description String
    (Updatable) The description of the news report.
    locale String
    (Updatable) Language of the news report.
    newsFrequency String
    (Updatable) News report frequency.
    onsTopicId String
    (Updatable) The OCID of the ONS topic.
    areChildCompartmentsIncluded Boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    dayOfWeek String
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags 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"}
    name String
    (Updatable) The news report name.
    status String

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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) Compartment Identifier where the news report will be created.
    contentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    description string
    (Updatable) The description of the news report.
    locale string
    (Updatable) Language of the news report.
    newsFrequency string
    (Updatable) News report frequency.
    onsTopicId string
    (Updatable) The OCID of the ONS topic.
    areChildCompartmentsIncluded boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    dayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[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"}
    name string
    (Updatable) The news report name.
    status string

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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) Compartment Identifier where the news report will be created.
    content_types opsi.NewsReportContentTypesArgs
    (Updatable) Content types that the news report can handle.
    description str
    (Updatable) The description of the news report.
    locale str
    (Updatable) Language of the news report.
    news_frequency str
    (Updatable) News report frequency.
    ons_topic_id str
    (Updatable) The OCID of the ONS topic.
    are_child_compartments_included bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    day_of_week str
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags 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"}
    name str
    (Updatable) The news report name.
    status str

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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) Compartment Identifier where the news report will be created.
    contentTypes Property Map
    (Updatable) Content types that the news report can handle.
    description String
    (Updatable) The description of the news report.
    locale String
    (Updatable) Language of the news report.
    newsFrequency String
    (Updatable) News report frequency.
    onsTopicId String
    (Updatable) The OCID of the ONS topic.
    areChildCompartmentsIncluded Boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    dayOfWeek String
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags 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"}
    name String
    (Updatable) The news report name.
    status String

    (Updatable) Defines if the news report will be enabled or disabled.

    ** 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 NewsReport resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the news report.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the news report.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the news report.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the news report was updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state string
    The current state of the news report.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state str
    The current state of the news report.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    time_updated str
    The time the news report was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the news report.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the news report was updated. An RFC3339 formatted datetime string.

    Look up Existing NewsReport Resource

    Get an existing NewsReport 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?: NewsReportState, opts?: CustomResourceOptions): NewsReport
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            are_child_compartments_included: Optional[bool] = None,
            compartment_id: Optional[str] = None,
            content_types: Optional[_opsi.NewsReportContentTypesArgs] = None,
            day_of_week: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            lifecycle_details: Optional[str] = None,
            locale: Optional[str] = None,
            name: Optional[str] = None,
            news_frequency: Optional[str] = None,
            ons_topic_id: Optional[str] = None,
            state: Optional[str] = None,
            status: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> NewsReport
    func GetNewsReport(ctx *Context, name string, id IDInput, state *NewsReportState, opts ...ResourceOption) (*NewsReport, error)
    public static NewsReport Get(string name, Input<string> id, NewsReportState? state, CustomResourceOptions? opts = null)
    public static NewsReport get(String name, Output<String> id, NewsReportState 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.
    The following state arguments are supported:
    AreChildCompartmentsIncluded bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    CompartmentId string
    (Updatable) Compartment Identifier where the news report will be created.
    ContentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    DayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    DefinedTags 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) The description of the news report.
    FreeformTags 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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Locale string
    (Updatable) Language of the news report.
    Name string
    (Updatable) The news report name.
    NewsFrequency string
    (Updatable) News report frequency.
    OnsTopicId string
    (Updatable) The OCID of the ONS topic.
    State string
    The current state of the news report.
    Status string

    (Updatable) Defines if the news report will be enabled or disabled.

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

    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    AreChildCompartmentsIncluded bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    CompartmentId string
    (Updatable) Compartment Identifier where the news report will be created.
    ContentTypes NewsReportContentTypesArgs
    (Updatable) Content types that the news report can handle.
    DayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    DefinedTags 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) The description of the news report.
    FreeformTags 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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Locale string
    (Updatable) Language of the news report.
    Name string
    (Updatable) The news report name.
    NewsFrequency string
    (Updatable) News report frequency.
    OnsTopicId string
    (Updatable) The OCID of the ONS topic.
    State string
    The current state of the news report.
    Status string

    (Updatable) Defines if the news report will be enabled or disabled.

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

    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    areChildCompartmentsIncluded Boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    compartmentId String
    (Updatable) Compartment Identifier where the news report will be created.
    contentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    dayOfWeek String
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags 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) The description of the news report.
    freeformTags 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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locale String
    (Updatable) Language of the news report.
    name String
    (Updatable) The news report name.
    newsFrequency String
    (Updatable) News report frequency.
    onsTopicId String
    (Updatable) The OCID of the ONS topic.
    state String
    The current state of the news report.
    status String

    (Updatable) Defines if the news report will be enabled or disabled.

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

    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the news report was updated. An RFC3339 formatted datetime string.
    areChildCompartmentsIncluded boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    compartmentId string
    (Updatable) Compartment Identifier where the news report will be created.
    contentTypes NewsReportContentTypes
    (Updatable) Content types that the news report can handle.
    dayOfWeek string
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags {[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) The description of the news report.
    freeformTags {[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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locale string
    (Updatable) Language of the news report.
    name string
    (Updatable) The news report name.
    newsFrequency string
    (Updatable) News report frequency.
    onsTopicId string
    (Updatable) The OCID of the ONS topic.
    state string
    The current state of the news report.
    status string

    (Updatable) Defines if the news report will be enabled or disabled.

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

    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the news report was updated. An RFC3339 formatted datetime string.
    are_child_compartments_included bool
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    compartment_id str
    (Updatable) Compartment Identifier where the news report will be created.
    content_types opsi.NewsReportContentTypesArgs
    (Updatable) Content types that the news report can handle.
    day_of_week str
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    defined_tags 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) The description of the news report.
    freeform_tags 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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locale str
    (Updatable) Language of the news report.
    name str
    (Updatable) The news report name.
    news_frequency str
    (Updatable) News report frequency.
    ons_topic_id str
    (Updatable) The OCID of the ONS topic.
    state str
    The current state of the news report.
    status str

    (Updatable) Defines if the news report will be enabled or disabled.

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

    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    time_updated str
    The time the news report was updated. An RFC3339 formatted datetime string.
    areChildCompartmentsIncluded Boolean
    (Updatable) A flag to consider the resources within a given compartment and all sub-compartments.
    compartmentId String
    (Updatable) Compartment Identifier where the news report will be created.
    contentTypes Property Map
    (Updatable) Content types that the news report can handle.
    dayOfWeek String
    (Updatable) Day of the week in which the news report will be sent if the frequency is set to WEEKLY.
    definedTags 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) The description of the news report.
    freeformTags 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 state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locale String
    (Updatable) Language of the news report.
    name String
    (Updatable) The news report name.
    newsFrequency String
    (Updatable) News report frequency.
    onsTopicId String
    (Updatable) The OCID of the ONS topic.
    state String
    The current state of the news report.
    status String

    (Updatable) Defines if the news report will be enabled or disabled.

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

    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the news report was first enabled. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the news report was updated. An RFC3339 formatted datetime string.

    Supporting Types

    NewsReportContentTypes, NewsReportContentTypesArgs

    CapacityPlanningResources List<string>
    (Updatable) Supported resources for capacity planning content type.
    SqlInsightsFleetAnalysisResources List<string>
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    SqlInsightsPerformanceDegradationResources List<string>
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    SqlInsightsPlanChangesResources List<string>
    (Updatable) Supported resources for SQL insights - plan changes content type.
    SqlInsightsTopDatabasesResources List<string>
    (Updatable) Supported resources for SQL insights - top databases content type.
    SqlInsightsTopSqlByInsightsResources List<string>
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    SqlInsightsTopSqlResources List<string>
    (Updatable) Supported resources for SQL insights - top SQL content type.
    CapacityPlanningResources []string
    (Updatable) Supported resources for capacity planning content type.
    SqlInsightsFleetAnalysisResources []string
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    SqlInsightsPerformanceDegradationResources []string
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    SqlInsightsPlanChangesResources []string
    (Updatable) Supported resources for SQL insights - plan changes content type.
    SqlInsightsTopDatabasesResources []string
    (Updatable) Supported resources for SQL insights - top databases content type.
    SqlInsightsTopSqlByInsightsResources []string
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    SqlInsightsTopSqlResources []string
    (Updatable) Supported resources for SQL insights - top SQL content type.
    capacityPlanningResources List<String>
    (Updatable) Supported resources for capacity planning content type.
    sqlInsightsFleetAnalysisResources List<String>
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    sqlInsightsPerformanceDegradationResources List<String>
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    sqlInsightsPlanChangesResources List<String>
    (Updatable) Supported resources for SQL insights - plan changes content type.
    sqlInsightsTopDatabasesResources List<String>
    (Updatable) Supported resources for SQL insights - top databases content type.
    sqlInsightsTopSqlByInsightsResources List<String>
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    sqlInsightsTopSqlResources List<String>
    (Updatable) Supported resources for SQL insights - top SQL content type.
    capacityPlanningResources string[]
    (Updatable) Supported resources for capacity planning content type.
    sqlInsightsFleetAnalysisResources string[]
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    sqlInsightsPerformanceDegradationResources string[]
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    sqlInsightsPlanChangesResources string[]
    (Updatable) Supported resources for SQL insights - plan changes content type.
    sqlInsightsTopDatabasesResources string[]
    (Updatable) Supported resources for SQL insights - top databases content type.
    sqlInsightsTopSqlByInsightsResources string[]
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    sqlInsightsTopSqlResources string[]
    (Updatable) Supported resources for SQL insights - top SQL content type.
    capacity_planning_resources Sequence[str]
    (Updatable) Supported resources for capacity planning content type.
    sql_insights_fleet_analysis_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    sql_insights_performance_degradation_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    sql_insights_plan_changes_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - plan changes content type.
    sql_insights_top_databases_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - top databases content type.
    sql_insights_top_sql_by_insights_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    sql_insights_top_sql_resources Sequence[str]
    (Updatable) Supported resources for SQL insights - top SQL content type.
    capacityPlanningResources List<String>
    (Updatable) Supported resources for capacity planning content type.
    sqlInsightsFleetAnalysisResources List<String>
    (Updatable) Supported resources for SQL insights - fleet analysis content type.
    sqlInsightsPerformanceDegradationResources List<String>
    (Updatable) Supported resources for SQL insights - performance degradation content type.
    sqlInsightsPlanChangesResources List<String>
    (Updatable) Supported resources for SQL insights - plan changes content type.
    sqlInsightsTopDatabasesResources List<String>
    (Updatable) Supported resources for SQL insights - top databases content type.
    sqlInsightsTopSqlByInsightsResources List<String>
    (Updatable) Supported resources for SQL insights - top SQL by insights content type.
    sqlInsightsTopSqlResources List<String>
    (Updatable) Supported resources for SQL insights - top SQL content type.

    Import

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

    $ pulumi import oci:Opsi/newsReport:NewsReport test_news_report "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi