EventRule

• Implements: IEventRule

This class encapsulates and extends the ROS resource type ALIYUN::CMS::EventRule, which is used to create or modify an event-triggered alert rule.

If the specified rule name does not exist, an event-triggered alert rule is created. If the specified rule name exists, the specified event-triggered alert rule is modified.

Initializers

import ros_cdk_cms
ros_cdk_cms.EventRule(
  scope: Construct,
  id: str,
  event_pattern: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EventPatternProperty]]],
  rule_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  event_type: typing.Union[str, IResolvable] = None,
  group_id: typing.Union[str, IResolvable] = None,
  silence_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  state: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

event_pattern^Required

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

Property eventPattern: Event pattern configuration.A maximum of 20 event patterns.

rule_name^Required

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

Property ruleName: The name of the alarm rule.

description^Optional

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

Property description: The description of the alert rule.

event_type^Optional

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

Property eventType: The type of the event alert.

Valid values: SYSTEM CUSTOM

group_id^Optional

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

Property groupId: The ID of the application group.

silence_time^Optional

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

Property silenceTime: Channel silence time in seconds.

state^Optional

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

Property state: The status of the alert rule.

Valid values: ENABLED DISABLED

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.EventRule.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_data^Required

attr_data: typing.Union[str, IResolvable]

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

Attribute Data: Number of rows affected.

props^Required

props: EventRuleProps

• Type: EventRuleProps