CreateMonitoringTemplateDetails

class oci.stack_monitoring.models.CreateMonitoringTemplateDetails(**kwargs)

Bases: object

The information about new monitoring template. The monitoring template name should be unique in a compartment.

Attributes:

MESSAGE_FORMAT_ONS_OPTIMIZED	A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails.
MESSAGE_FORMAT_PRETTY_JSON	A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails.
MESSAGE_FORMAT_RAW	A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails.
compartment_id	[Required] Gets the compartment_id of this CreateMonitoringTemplateDetails.
defined_tags	Gets the defined_tags of this CreateMonitoringTemplateDetails.
description	Gets the description of this CreateMonitoringTemplateDetails.
destinations	[Required] Gets the destinations of this CreateMonitoringTemplateDetails.
display_name	[Required] Gets the display_name of this CreateMonitoringTemplateDetails.
freeform_tags	Gets the freeform_tags of this CreateMonitoringTemplateDetails.
is_alarms_enabled	Gets the is_alarms_enabled of this CreateMonitoringTemplateDetails.
is_split_notification_enabled	Gets the is_split_notification_enabled of this CreateMonitoringTemplateDetails.
members	[Required] Gets the members of this CreateMonitoringTemplateDetails.
message_format	Gets the message_format of this CreateMonitoringTemplateDetails.
repeat_notification_duration	Gets the repeat_notification_duration of this CreateMonitoringTemplateDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateMonitoringTemplateDetails object with values from keyword arguments.

MESSAGE_FORMAT_ONS_OPTIMIZED = 'ONS_OPTIMIZED'

A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails. This constant has a value of “ONS_OPTIMIZED”

MESSAGE_FORMAT_PRETTY_JSON = 'PRETTY_JSON'

A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails. This constant has a value of “PRETTY_JSON”

MESSAGE_FORMAT_RAW = 'RAW'

A constant which can be used with the message_format property of a CreateMonitoringTemplateDetails. This constant has a value of “RAW”

__init__(**kwargs)

Initializes a new CreateMonitoringTemplateDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• display_name (str) – The value to assign to the display_name property of this CreateMonitoringTemplateDetails.

• compartment_id (str) – The value to assign to the compartment_id property of this CreateMonitoringTemplateDetails.

• description (str) – The value to assign to the description property of this CreateMonitoringTemplateDetails.

• destinations (list[str]) – The value to assign to the destinations property of this CreateMonitoringTemplateDetails.

• is_alarms_enabled (bool) – The value to assign to the is_alarms_enabled property of this CreateMonitoringTemplateDetails.

• is_split_notification_enabled (bool) – The value to assign to the is_split_notification_enabled property of this CreateMonitoringTemplateDetails.

• members (list[oci.stack_monitoring.models.MemberReference]) – The value to assign to the members property of this CreateMonitoringTemplateDetails.

• repeat_notification_duration (str) – The value to assign to the repeat_notification_duration property of this CreateMonitoringTemplateDetails.

• message_format (str) – The value to assign to the message_format property of this CreateMonitoringTemplateDetails. Allowed values for this property are: “RAW”, “PRETTY_JSON”, “ONS_OPTIMIZED”

• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMonitoringTemplateDetails.

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMonitoringTemplateDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateMonitoringTemplateDetails. The OCID of the compartment containing the monitoringTemplate.

Returns

The compartment_id of this CreateMonitoringTemplateDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateMonitoringTemplateDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this CreateMonitoringTemplateDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateMonitoringTemplateDetails. A user-friendly description for the monitoring template. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The description of this CreateMonitoringTemplateDetails.

Return type

str

property destinations

[Required] Gets the destinations of this CreateMonitoringTemplateDetails. A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic.

Returns

The destinations of this CreateMonitoringTemplateDetails.

Return type

list[str]

property display_name

[Required] Gets the display_name of this CreateMonitoringTemplateDetails. A user-friendly name for the monitoring template. It is unique and mutable in nature. Avoid entering confidential information.

Returns

The display_name of this CreateMonitoringTemplateDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateMonitoringTemplateDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this CreateMonitoringTemplateDetails.

Return type

dict(str, str)

property is_alarms_enabled

Gets the is_alarms_enabled of this CreateMonitoringTemplateDetails. Whether the alarm is enabled or disabled, it will be Enabled by default.

Returns

The is_alarms_enabled of this CreateMonitoringTemplateDetails.

Return type

bool

property is_split_notification_enabled

Gets the is_split_notification_enabled of this CreateMonitoringTemplateDetails. Whether the alarm notification is enabled or disabled, it will be Enabled by default.

Returns

The is_split_notification_enabled of this CreateMonitoringTemplateDetails.

Return type

bool

property members

[Required] Gets the members of this CreateMonitoringTemplateDetails. List of members of this monitoring template

Returns

The members of this CreateMonitoringTemplateDetails.

Return type

list[oci.stack_monitoring.models.MemberReference]

property message_format

Gets the message_format of this CreateMonitoringTemplateDetails. The format to use for alarm notifications.

Allowed values for this property are: “RAW”, “PRETTY_JSON”, “ONS_OPTIMIZED”

Returns

The message_format of this CreateMonitoringTemplateDetails.

Return type

str

property repeat_notification_duration

Gets the repeat_notification_duration of this CreateMonitoringTemplateDetails. 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.

Returns

The repeat_notification_duration of this CreateMonitoringTemplateDetails.

Return type

str