Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. MonitoringTemplate
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.StackMonitoring.MonitoringTemplate

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Monitoring Template resource in Oracle Cloud Infrastructure Stack Monitoring service.

    Creates a new monitoring template for a given compartment.

    Example Usage

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

const testMonitoringTemplate = new oci.stackmonitoring.MonitoringTemplate("test_monitoring_template", {
    compartmentId: compartmentId,
    destinations: monitoringTemplateDestinations,
    displayName: monitoringTemplateDisplayName,
    members: [{
        id: monitoringTemplateMembersId,
        type: monitoringTemplateMembersType,
        compositeType: monitoringTemplateMembersCompositeType,
    }],
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: monitoringTemplateDescription,
    freeformTags: {
        "bar-key": "value",
    },
    isAlarmsEnabled: monitoringTemplateIsAlarmsEnabled,
    isSplitNotificationEnabled: monitoringTemplateIsSplitNotificationEnabled,
    messageFormat: monitoringTemplateMessageFormat,
    repeatNotificationDuration: monitoringTemplateRepeatNotificationDuration,
});

    import pulumi
import pulumi_oci as oci

test_monitoring_template = oci.stack_monitoring.MonitoringTemplate("test_monitoring_template",
    compartment_id=compartment_id,
    destinations=monitoring_template_destinations,
    display_name=monitoring_template_display_name,
    members=[{
        "id": monitoring_template_members_id,
        "type": monitoring_template_members_type,
        "composite_type": monitoring_template_members_composite_type,
    }],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=monitoring_template_description,
    freeform_tags={
        "bar-key": "value",
    },
    is_alarms_enabled=monitoring_template_is_alarms_enabled,
    is_split_notification_enabled=monitoring_template_is_split_notification_enabled,
    message_format=monitoring_template_message_format,
    repeat_notification_duration=monitoring_template_repeat_notification_duration)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stackmonitoring.NewMonitoringTemplate(ctx, "test_monitoring_template", &stackmonitoring.MonitoringTemplateArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Destinations:  pulumi.Any(monitoringTemplateDestinations),
			DisplayName:   pulumi.Any(monitoringTemplateDisplayName),
			Members: stackmonitoring.MonitoringTemplateMemberArray{
				&stackmonitoring.MonitoringTemplateMemberArgs{
					Id:            pulumi.Any(monitoringTemplateMembersId),
					Type:          pulumi.Any(monitoringTemplateMembersType),
					CompositeType: pulumi.Any(monitoringTemplateMembersCompositeType),
				},
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(monitoringTemplateDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsAlarmsEnabled:            pulumi.Any(monitoringTemplateIsAlarmsEnabled),
			IsSplitNotificationEnabled: pulumi.Any(monitoringTemplateIsSplitNotificationEnabled),
			MessageFormat:              pulumi.Any(monitoringTemplateMessageFormat),
			RepeatNotificationDuration: pulumi.Any(monitoringTemplateRepeatNotificationDuration),
		})
		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 testMonitoringTemplate = new Oci.StackMonitoring.MonitoringTemplate("test_monitoring_template", new()
    {
        CompartmentId = compartmentId,
        Destinations = monitoringTemplateDestinations,
        DisplayName = monitoringTemplateDisplayName,
        Members = new[]
        {
            new Oci.StackMonitoring.Inputs.MonitoringTemplateMemberArgs
            {
                Id = monitoringTemplateMembersId,
                Type = monitoringTemplateMembersType,
                CompositeType = monitoringTemplateMembersCompositeType,
            },
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = monitoringTemplateDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsAlarmsEnabled = monitoringTemplateIsAlarmsEnabled,
        IsSplitNotificationEnabled = monitoringTemplateIsSplitNotificationEnabled,
        MessageFormat = monitoringTemplateMessageFormat,
        RepeatNotificationDuration = monitoringTemplateRepeatNotificationDuration,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.StackMonitoring.MonitoringTemplate;
import com.pulumi.oci.StackMonitoring.MonitoringTemplateArgs;
import com.pulumi.oci.StackMonitoring.inputs.MonitoringTemplateMemberArgs;
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 testMonitoringTemplate = new MonitoringTemplate("testMonitoringTemplate", MonitoringTemplateArgs.builder()
            .compartmentId(compartmentId)
            .destinations(monitoringTemplateDestinations)
            .displayName(monitoringTemplateDisplayName)
            .members(MonitoringTemplateMemberArgs.builder()
                .id(monitoringTemplateMembersId)
                .type(monitoringTemplateMembersType)
                .compositeType(monitoringTemplateMembersCompositeType)
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(monitoringTemplateDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .isAlarmsEnabled(monitoringTemplateIsAlarmsEnabled)
            .isSplitNotificationEnabled(monitoringTemplateIsSplitNotificationEnabled)
            .messageFormat(monitoringTemplateMessageFormat)
            .repeatNotificationDuration(monitoringTemplateRepeatNotificationDuration)
            .build());

    }
}

    resources:
  testMonitoringTemplate:
    type: oci:StackMonitoring:MonitoringTemplate
    name: test_monitoring_template
    properties:
      compartmentId: ${compartmentId}
      destinations: ${monitoringTemplateDestinations}
      displayName: ${monitoringTemplateDisplayName}
      members:
        - id: ${monitoringTemplateMembersId}
          type: ${monitoringTemplateMembersType}
          compositeType: ${monitoringTemplateMembersCompositeType}
      definedTags:
        foo-namespace.bar-key: value
      description: ${monitoringTemplateDescription}
      freeformTags:
        bar-key: value
      isAlarmsEnabled: ${monitoringTemplateIsAlarmsEnabled}
      isSplitNotificationEnabled: ${monitoringTemplateIsSplitNotificationEnabled}
      messageFormat: ${monitoringTemplateMessageFormat}
      repeatNotificationDuration: ${monitoringTemplateRepeatNotificationDuration}

    Create MonitoringTemplate Resource

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

    Constructor syntax

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

@overload
def MonitoringTemplate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       compartment_id: Optional[str] = None,
                       destinations: Optional[Sequence[str]] = None,
                       display_name: Optional[str] = None,
                       members: Optional[Sequence[_stackmonitoring.MonitoringTemplateMemberArgs]] = None,
                       defined_tags: Optional[Mapping[str, str]] = None,
                       description: Optional[str] = None,
                       freeform_tags: Optional[Mapping[str, str]] = None,
                       is_alarms_enabled: Optional[bool] = None,
                       is_split_notification_enabled: Optional[bool] = None,
                       message_format: Optional[str] = None,
                       repeat_notification_duration: Optional[str] = None)
    func NewMonitoringTemplate(ctx *Context, name string, args MonitoringTemplateArgs, opts ...ResourceOption) (*MonitoringTemplate, error)
    public MonitoringTemplate(string name, MonitoringTemplateArgs args, CustomResourceOptions? opts = null)
    public MonitoringTemplate(String name, MonitoringTemplateArgs args)
public MonitoringTemplate(String name, MonitoringTemplateArgs args, CustomResourceOptions options)

    type: oci:StackMonitoring:MonitoringTemplate
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 MonitoringTemplateArgs
    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 MonitoringTemplateArgs
    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 MonitoringTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitoringTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitoringTemplateArgs
    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 monitoringTemplateResource = new Oci.StackMonitoring.MonitoringTemplate("monitoringTemplateResource", new()
{
    CompartmentId = "string",
    Destinations = new[]
    {
        "string",
    },
    DisplayName = "string",
    Members = new[]
    {
        new Oci.StackMonitoring.Inputs.MonitoringTemplateMemberArgs
        {
            Id = "string",
            Type = "string",
            CompositeType = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsAlarmsEnabled = false,
    IsSplitNotificationEnabled = false,
    MessageFormat = "string",
    RepeatNotificationDuration = "string",
});

    example, err := StackMonitoring.NewMonitoringTemplate(ctx, "monitoringTemplateResource", &StackMonitoring.MonitoringTemplateArgs{
	CompartmentId: pulumi.String("string"),
	Destinations: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Members: stackmonitoring.MonitoringTemplateMemberArray{
		&stackmonitoring.MonitoringTemplateMemberArgs{
			Id:            pulumi.String("string"),
			Type:          pulumi.String("string"),
			CompositeType: pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsAlarmsEnabled:            pulumi.Bool(false),
	IsSplitNotificationEnabled: pulumi.Bool(false),
	MessageFormat:              pulumi.String("string"),
	RepeatNotificationDuration: pulumi.String("string"),
})

    var monitoringTemplateResource = new MonitoringTemplate("monitoringTemplateResource", MonitoringTemplateArgs.builder()
    .compartmentId("string")
    .destinations("string")
    .displayName("string")
    .members(MonitoringTemplateMemberArgs.builder()
        .id("string")
        .type("string")
        .compositeType("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .isAlarmsEnabled(false)
    .isSplitNotificationEnabled(false)
    .messageFormat("string")
    .repeatNotificationDuration("string")
    .build());

    monitoring_template_resource = oci.stack_monitoring.MonitoringTemplate("monitoringTemplateResource",
    compartment_id="string",
    destinations=["string"],
    display_name="string",
    members=[{
        "id": "string",
        "type": "string",
        "composite_type": "string",
    }],
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    is_alarms_enabled=False,
    is_split_notification_enabled=False,
    message_format="string",
    repeat_notification_duration="string")

    const monitoringTemplateResource = new oci.stackmonitoring.MonitoringTemplate("monitoringTemplateResource", {
    compartmentId: "string",
    destinations: ["string"],
    displayName: "string",
    members: [{
        id: "string",
        type: "string",
        compositeType: "string",
    }],
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    isAlarmsEnabled: false,
    isSplitNotificationEnabled: false,
    messageFormat: "string",
    repeatNotificationDuration: "string",
});

    type: oci:StackMonitoring:MonitoringTemplate
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    destinations:
        - string
    displayName: string
    freeformTags:
        string: string
    isAlarmsEnabled: false
    isSplitNotificationEnabled: false
    members:
        - compositeType: string
          id: string
          type: string
    messageFormat: string
    repeatNotificationDuration: string

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

    CompartmentId string
    The OCID of the compartment containing the monitoringTemplate.
    Destinations List<string>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    DisplayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    Members List<MonitoringTemplateMember>
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    IsAlarmsEnabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    IsSplitNotificationEnabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    MessageFormat string
    (Updatable) The format to use for alarm notifications.
    RepeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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
    The OCID of the compartment containing the monitoringTemplate.
    Destinations []string
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    DisplayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    Members []MonitoringTemplateMemberArgs
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    IsAlarmsEnabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    IsSplitNotificationEnabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    MessageFormat string
    (Updatable) The format to use for alarm notifications.
    RepeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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
    The OCID of the compartment containing the monitoringTemplate.
    destinations List<String>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName String
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    members List<MonitoringTemplateMember>
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    isAlarmsEnabled Boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled Boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    messageFormat String
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration String

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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
    The OCID of the compartment containing the monitoringTemplate.
    destinations string[]
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    members MonitoringTemplateMember[]
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    isAlarmsEnabled boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    messageFormat string
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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
    The OCID of the compartment containing the monitoringTemplate.
    destinations Sequence[str]
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    display_name str
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    members Sequence[stackmonitoring.MonitoringTemplateMemberArgs]
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    is_alarms_enabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    is_split_notification_enabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    message_format str
    (Updatable) The format to use for alarm notifications.
    repeat_notification_duration str

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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
    The OCID of the compartment containing the monitoringTemplate.
    destinations List<String>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName String
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    members List<Property Map>
    (Updatable) List of members of this monitoring template
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    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"}
    isAlarmsEnabled Boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled Boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    messageFormat String
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration String

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the monitoring template.
    Status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenantId string
    Tenant Identifier OCID
    TimeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    TotalAlarmConditions double
    Total Alarm Conditions
    TotalAppliedAlarmConditions double
    Total Applied Alarm Conditions
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the monitoring template.
    Status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenantId string
    Tenant Identifier OCID
    TimeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    TotalAlarmConditions float64
    Total Alarm Conditions
    TotalAppliedAlarmConditions float64
    Total Applied Alarm Conditions
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the monitoring template.
    status String
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId String
    Tenant Identifier OCID
    timeCreated String
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions Double
    Total Alarm Conditions
    totalAppliedAlarmConditions Double
    Total Applied Alarm Conditions
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current lifecycle state of the monitoring template.
    status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId string
    Tenant Identifier OCID
    timeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions number
    Total Alarm Conditions
    totalAppliedAlarmConditions number
    Total Applied Alarm Conditions
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current lifecycle state of the monitoring template.
    status str
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenant_id str
    Tenant Identifier OCID
    time_created str
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    time_updated str
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    total_alarm_conditions float
    Total Alarm Conditions
    total_applied_alarm_conditions float
    Total Applied Alarm Conditions
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the monitoring template.
    status String
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId String
    Tenant Identifier OCID
    timeCreated String
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions Number
    Total Alarm Conditions
    totalAppliedAlarmConditions Number
    Total Applied Alarm Conditions

    Look up Existing MonitoringTemplate Resource

    Get an existing MonitoringTemplate 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?: MonitoringTemplateState, opts?: CustomResourceOptions): MonitoringTemplate
    @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,
        destinations: Optional[Sequence[str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_alarms_enabled: Optional[bool] = None,
        is_split_notification_enabled: Optional[bool] = None,
        members: Optional[Sequence[_stackmonitoring.MonitoringTemplateMemberArgs]] = None,
        message_format: Optional[str] = None,
        repeat_notification_duration: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        tenant_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        total_alarm_conditions: Optional[float] = None,
        total_applied_alarm_conditions: Optional[float] = None) -> MonitoringTemplate
    func GetMonitoringTemplate(ctx *Context, name string, id IDInput, state *MonitoringTemplateState, opts ...ResourceOption) (*MonitoringTemplate, error)
    public static MonitoringTemplate Get(string name, Input<string> id, MonitoringTemplateState? state, CustomResourceOptions? opts = null)
    public static MonitoringTemplate get(String name, Output<String> id, MonitoringTemplateState state, CustomResourceOptions options)
    resources:  _:    type: oci:StackMonitoring:MonitoringTemplate    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.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    Destinations List<string>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    DisplayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    IsAlarmsEnabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    IsSplitNotificationEnabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    Members List<MonitoringTemplateMember>
    (Updatable) List of members of this monitoring template
    MessageFormat string
    (Updatable) The format to use for alarm notifications.
    RepeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    Status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenantId string
    Tenant Identifier OCID
    TimeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    TotalAlarmConditions double
    Total Alarm Conditions
    TotalAppliedAlarmConditions double
    Total Applied Alarm Conditions
    CompartmentId string
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    Destinations []string
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    DisplayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    IsAlarmsEnabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    IsSplitNotificationEnabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    Members []MonitoringTemplateMemberArgs
    (Updatable) List of members of this monitoring template
    MessageFormat string
    (Updatable) The format to use for alarm notifications.
    RepeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    Status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenantId string
    Tenant Identifier OCID
    TimeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    TotalAlarmConditions float64
    Total Alarm Conditions
    TotalAppliedAlarmConditions float64
    Total Applied Alarm Conditions
    compartmentId String
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    destinations List<String>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName String
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    isAlarmsEnabled Boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled Boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    members List<MonitoringTemplateMember>
    (Updatable) List of members of this monitoring template
    messageFormat String
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration String

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    status String
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId String
    Tenant Identifier OCID
    timeCreated String
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions Double
    Total Alarm Conditions
    totalAppliedAlarmConditions Double
    Total Applied Alarm Conditions
    compartmentId string
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    destinations string[]
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName string
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    isAlarmsEnabled boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    members MonitoringTemplateMember[]
    (Updatable) List of members of this monitoring template
    messageFormat string
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration string

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    status string
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId string
    Tenant Identifier OCID
    timeCreated string
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated string
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions number
    Total Alarm Conditions
    totalAppliedAlarmConditions number
    Total Applied Alarm Conditions
    compartment_id str
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    destinations Sequence[str]
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    display_name str
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    is_alarms_enabled bool
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    is_split_notification_enabled bool
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    members Sequence[stackmonitoring.MonitoringTemplateMemberArgs]
    (Updatable) List of members of this monitoring template
    message_format str
    (Updatable) The format to use for alarm notifications.
    repeat_notification_duration str

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    status str
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenant_id str
    Tenant Identifier OCID
    time_created str
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    time_updated str
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    total_alarm_conditions float
    Total Alarm Conditions
    total_applied_alarm_conditions float
    Total Applied Alarm Conditions
    compartmentId String
    The OCID of the compartment containing the monitoringTemplate.
    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) A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    destinations List<String>
    (Updatable) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.
    displayName String
    (Updatable) A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.
    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"}
    isAlarmsEnabled Boolean
    (Updatable) Whether the alarm is enabled or disabled, it will be Enabled by default.
    isSplitNotificationEnabled Boolean
    (Updatable) Whether the alarm notification is enabled or disabled, it will be Enabled by default.
    members List<Property Map>
    (Updatable) List of members of this monitoring template
    messageFormat String
    (Updatable) The format to use for alarm notifications.
    repeatNotificationDuration String

    (Updatable) The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

    ** 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 monitoring template.
    status String
    The current status of the monitoring template i.e. whether it is Applied or NotApplied.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenantId String
    Tenant Identifier OCID
    timeCreated String
    The date and time the monitoringTemplate was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the monitoringTemplate was last updated. Format defined by RFC3339.
    totalAlarmConditions Number
    Total Alarm Conditions
    totalAppliedAlarmConditions Number
    Total Applied Alarm Conditions

    Supporting Types

    MonitoringTemplateMember, MonitoringTemplateMemberArgs

    Id string
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    Type string
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    CompositeType string
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.
    Id string
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    Type string
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    CompositeType string
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.
    id String
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    type String
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    compositeType String
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.
    id string
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    type string
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    compositeType string
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.
    id str
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    type str
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    composite_type str
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.
    id String
    (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup
    type String
    (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP
    compositeType String
    (Updatable) The OCID of the composite resource type like EBS or Peoplesoft.

    Import

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

    $ pulumi import oci:StackMonitoring/monitoringTemplate:MonitoringTemplate test_monitoring_template "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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci