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 com.aliyun.ros.cdk.cms.EventRule;
EventRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.eventPattern(IResolvable)
.eventPattern(java.util.List<IResolvable)
.eventPattern(EventPatternProperty>)
.ruleName(java.lang.String)
.ruleName(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .eventType(java.lang.String)
// .eventType(IResolvable)
// .groupId(java.lang.String)
// .groupId(IResolvable)
// .silenceTime(java.lang.Number)
// .silenceTime(IResolvable)
// .state(java.lang.String)
// .state(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
eventPattern | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property eventPattern: Event pattern configuration.A maximum of 20 event patterns. |
ruleName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ruleName: The name of the alarm rule. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the alert rule. |
eventType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property eventType: The type of the event alert. |
groupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupId: The ID of the application group. |
silenceTime | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property silenceTime: Channel silence time in seconds. |
state | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property state: The status of the alert rule. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
eventPatternRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
EventPatternProperty>
Property eventPattern: Event pattern configuration.A maximum of 20 event patterns.
ruleNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ruleName: The name of the alarm rule.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the alert rule.
eventTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property eventType: The type of the event alert.
Valid values: SYSTEM CUSTOM
groupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupId: The ID of the application group.
silenceTimeOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property silenceTime: Channel silence time in seconds.
stateOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property state: The status of the alert rule.
Valid values: ENABLED DISABLED
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cms.EventRule;
EventRule.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Data: Number of rows affected. |
props | EventRuleProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrDataRequired
public java.lang.Object getAttrData();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Data: Number of rows affected.
propsRequired
public EventRuleProps getProps();
- Type: EventRuleProps