Skip to content

GroupMetricRule

This class encapsulates and extends the ROS resource type ALIYUN::CMS::GroupMetricRule, which is used to create an alert rule for an application group.

Initializers 

import ros_cdk_cms
ros_cdk_cms.GroupMetricRule(
  scope: Construct,
  id: str,
  category: typing.Union[str, IResolvable],
  escalations: typing.Union[IResolvable, EscalationsProperty],
  group_id: typing.Union[str, IResolvable],
  metric_name: typing.Union[str, IResolvable],
  namespace: typing.Union[str, IResolvable],
  rule_id: typing.Union[str, IResolvable],
  rule_name: typing.Union[str, IResolvable],
  dimensions: typing.Union[str, IResolvable] = None,
  effective_interval: typing.Union[str, IResolvable] = None,
  email_subject: typing.Union[str, IResolvable] = None,
  interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  no_effective_interval: typing.Union[str, IResolvable] = None,
  period: 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
category typing.Union[str, ros_cdk_core.IResolvable] Property category: The abbreviation of the service name.
escalations typing.Union[ros_cdk_core.IResolvable, EscalationsProperty] Property escalations: undefined.
group_id typing.Union[str, ros_cdk_core.IResolvable] Property groupId: The ID of application group.
metric_name typing.Union[str, ros_cdk_core.IResolvable] Property metricName: The name of the metric.
namespace typing.Union[str, ros_cdk_core.IResolvable] Property namespace: The data namespace of the service.
rule_id typing.Union[str, ros_cdk_core.IResolvable] Property ruleId: The ID of the alert rule.
rule_name typing.Union[str, ros_cdk_core.IResolvable] Property ruleName: The name of the alert rule.
dimensions typing.Union[str, ros_cdk_core.IResolvable] Property dimensions: The expended resource dimensions.
effective_interval typing.Union[str, ros_cdk_core.IResolvable] Property effectiveInterval: The period when the alert rule is effective.
email_subject typing.Union[str, ros_cdk_core.IResolvable] Property emailSubject: The subject of the alert notification email.
interval typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property interval: The detection period of alerts.
no_effective_interval typing.Union[str, ros_cdk_core.IResolvable] Property noEffectiveInterval: The period when the alert rule is ineffective.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The aggregation period.
silence_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property silenceTime: The duration of the mute period during which new alerts are not sent even if the trigger conditions are met.
webhook typing.Union[str, ros_cdk_core.IResolvable] Property webhook: The URL of the callback triggered when an alert occurs.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

categoryRequired

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

Property category: The abbreviation of the service name.

Valid values: ECS (including Alibaba Cloud and non-Alibaba Cloud hosts) RDS (ApsaraDB for RDS) ADS (AnalyticDB) SLB (Server Load Balancer) VPC (Virtual Private Cloud) APIGATEWAY (API Gateway) CDN CS (Container Service for Swarm) DCDN (Dynamic Route for CDN) DDoS (distributed denial of service) EIP (Elastic IP) ELASTICSEARCH (Elasticsearch) EMR (E-MapReduce) ESS (Auto Scaling) HBASE (ApsaraDB for HBase) IOT_EDGE (IoT Edge) K8S_POD (k8s pod) KVSTORE_SHARDING (ApsaraDB for Redis cluster version) KVSTORE_SPLITRW (ApsaraDB for Redis read/write splitting version) KVSTORE_STANDARD (ApsaraDB for Redis standard version) MEMCACHE (ApsaraDB for Memcache) MNS (Message Service) MONGODB (ApsaraDB for MongoDB replica set instances) MONGODB_CLUSTER (ApsaraDB for MongoDB cluster version) MONGODB_SHARDING (ApsaraDB for MongoDB sharded clusters) MQ_TOPIC (Message Service topic) OCS (original version of ApsaraDB for Memcache) OPENSEARCH (Open Search) OSS (Object Storage Service) POLARDB (ApsaraDB for POLARDB) PETADATA (HybridDB for MySQL) SCDN (Secure Content Delivery Network) SHAREBANDWIDTHPACKAGES (shared bandwidth package) SLS (Log Service) VPN (VPN Gateway)

escalationsRequired

Property escalations: undefined.

group_idRequired

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

Property groupId: The ID of application group.

metric_nameRequired

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

Property metricName: The name of the metric.

For more information, call DescribeMetricMetaList or see Preset metrics reference.

namespaceRequired

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

Property namespace: The data namespace of the service.

For more information, call DescribeMetricMetaList or see Preset metrics reference.

rule_idRequired

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

Property ruleId: The ID of the alert rule.

The IDs of alert rules are generated by callers to ensure uniqueness.

rule_nameRequired

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

Property ruleName: The name of the alert rule.

dimensionsOptional

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

Property dimensions: The expended resource dimensions.

effective_intervalOptional

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

Property effectiveInterval: The period when the alert rule is effective.

email_subjectOptional

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

Property emailSubject: The subject of the alert notification email.

intervalOptional

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

Property interval: The detection period of alerts.

no_effective_intervalOptional

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

Property noEffectiveInterval: The period when the alert rule is ineffective.

periodOptional

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

Property period: The aggregation period.

Unite: second.

silence_timeOptional

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

Property silenceTime: The duration of the mute period during which new alerts are not sent even if the trigger conditions are met.

Unit: second. Default value: 86400. Minimum value: 60.

webhookOptional

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

Property webhook: The URL of the callback triggered when an alert occurs.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_rule_id ros_cdk_core.IResolvable Attribute RuleId: Rule ID.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_rule_idRequired 

attr_rule_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RuleId: Rule ID.