MetricRuleTemplateDeployment

• Implements: IMetricRuleTemplateDeployment

This class encapsulates and extends the ROS resource type ALIYUN::CMS::MetricRuleTemplateDeployment.

Initializers

import ros_cdk_cms
ros_cdk_cms.MetricRuleTemplateDeployment(
  scope: Construct,
  id: str,
  group_id: typing.Union[typing.Union[int, float], IResolvable],
  template_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  append_mode: typing.Union[str, IResolvable] = None,
  apply_mode: typing.Union[str, IResolvable] = None,
  enable_end_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_start_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  notify_level: typing.Union[typing.Union[int, float], IResolvable] = None,
  silence_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  webhook: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

group_id^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property groupId: Apply group ID.

For how to get the application group ID, see DescribeMonitorGroups.

template_ids^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property templateIds: The ID list of the Alarm Template to be applied.

For how to get the alarm template ID, see DescribeMetricRuleTemplateList.

append_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property appendMode: Template application policy.Value: all: Delete all rules created by the alarm template on the selected group, and then create a new alarm rule by the template (default). append: Delete the rules created by the alarm template on the selected group, and then create a new alarm rule based on the current template.

apply_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property applyMode: How to apply templates.Value: GROUP_INSTANCE_FIRST: Application grouping instances are preferred.When applying an alarm template, the application grouping instance is preferred. If the instance does not exist in the application grouping, the rules in the template are ignored. ALARM_TEMPLATE_FIRST: Alarm template instances are preferred.When an alarm template is applied, an alarm rule is created regardless of whether the instance exists in the application group.

enable_end_time^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property enableEndTime: The end time when the alarm takes effect.Value range: 0~23, indicating 00:59 to 23:59.

enable_start_time^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property enableStartTime: The start time when the alarm takes effect.Value range: 0~23, indicating 00:00 to 23:00.

notify_level^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property notifyLevel: The alert notification method.

Valid values: Set the value to 4. A value of 4 indicates that alert notifications are sent by using TradeManager and DingTalk chatbots.

silence_time^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property silenceTime: Channel silence period.Unit: seconds.Default value: 86400. Note When the monitoring data continues to exceed the alarm rule threshold, only one alarm notification will be sent during each silence cycle.

webhook^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property webhook: When an alarm occurs, the specified URL address will be called back and a POST request will be sent.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_cms
ros_cdk_cms.MetricRuleTemplateDeployment.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_group_id^Required

attr_group_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute GroupId: The ID of the group that applied the template to.

attr_rule_ids^Required

attr_rule_ids: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleIds: The IDs of rhe generated rules.

props^Required

props: MetricRuleTemplateDeploymentProps

• Type: MetricRuleTemplateDeploymentProps