Skip to content

RuleProps

Properties for defining a Rule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-eventbridge-rule

Initializer 

import { RuleProps } from '@alicloud/ros-cdk-eventbridge'
const ruleProps: RuleProps = { ... }

Properties

Name Type Description
eventBusName string | @alicloud/ros-cdk-core.IResolvable Property eventBusName: The name of the event bus.
filterPattern @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property filterPattern: The event pattern, in the JSON format.
ruleName string | @alicloud/ros-cdk-core.IResolvable Property ruleName: The name of the event rule.
targets @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TargetsProperty[] Property targets: The event target to which events are delivered.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the event rule.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The status of the event rule.

eventBusNameRequired 

public readonly eventBusName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property eventBusName: The name of the event bus.

filterPatternRequired 

public readonly filterPattern: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property filterPattern: The event pattern, in the JSON format.

ruleNameRequired 

public readonly ruleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleName: The name of the event rule.

targetsRequired 

public readonly targets: IResolvable | IResolvable | TargetsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TargetsProperty[]

Property targets: The event target to which events are delivered.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the event rule.

statusOptional 

public readonly status: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property status: The status of the event rule.

Valid values: ENABLE: The event rule is enabled. It is the default state of the event rule. DISABLE: The event rule is disabled.