Rule

This class encapsulates and extends the ROS resource type ALIYUN::Config::Rule, which is used to create or modify a rule.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Config;
new Rule(Construct Scope, string Id, RuleProps Props, bool EnableResourcePropertyConstraint = null);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	No description.
Id	string	No description.
Props	RuleProps	No description.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

---

Id^Required

• Type: string

---

Props^Required

• Type: RuleProps

---

EnableResourcePropertyConstraint^Optional

• Type: bool

---

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.
GetAtt	No description.
SetMetadata	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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.

Session^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

---

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

---

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

Static Functions

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

---

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Config;
Rule.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
Ref	string	No description.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this resource is defined.
Resource	AlibabaCloud.SDK.ROS.CDK.Core.RosResource	No description.
AttrConfigRuleArn	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ConfigRuleArn: config rule arn.
AttrConfigRuleId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ConfigRuleId: The ID of the rule.
AttrConfigRuleTriggerTypes	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ConfigRuleTriggerTypes: The trigger type of the rule.
AttrDescription	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Description: The description of the rule.
AttrEventSource	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute EventSource: The event source of the rule.
AttrExcludeResourceIdsScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ExcludeResourceIdsScope: The rule monitors excluded resource IDs, multiple of which are separated by commas, only applies to rules created based on managed rules, , custom rule this field is empty.
AttrInputParameters	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute InputParameters: The settings of the input parameters for the rule.
AttrMaximumExecutionFrequency	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.
AttrRegionIdsScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceGroupIdsScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceTypesScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.
AttrRiskLevel	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute RiskLevel: The risk level of the resources that are not compliant with the rule.
AttrRuleName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute RuleName: The name of the rule.
AttrSourceIdentifier	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute SourceIdentifier: The identifier of the rule.
AttrSourceOwner	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.
AttrTagKeyScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
AttrTagValueScope	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

Ref^Required

public string Ref { get; }

• Type: string

---

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

---

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AttrConfigRuleArn^Required

public IResolvable AttrConfigRuleArn { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ConfigRuleArn: config rule arn.

---

AttrConfigRuleId^Required

public IResolvable AttrConfigRuleId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ConfigRuleId: The ID of the rule.

---

AttrConfigRuleTriggerTypes^Required

public IResolvable AttrConfigRuleTriggerTypes { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ConfigRuleTriggerTypes: The trigger type of the rule.

Valid values: ConfigurationItemChangeNotification: The rule is triggered upon configuration changes. ScheduledNotification: The rule is triggered as scheduled.

---

AttrDescription^Required

public IResolvable AttrDescription { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Description: The description of the rule.

---

AttrEventSource^Required

public IResolvable AttrEventSource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EventSource: The event source of the rule.

---

AttrExcludeResourceIdsScope^Required

public IResolvable AttrExcludeResourceIdsScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ExcludeResourceIdsScope: The rule monitors excluded resource IDs, multiple of which are separated by commas, only applies to rules created based on managed rules, , custom rule this field is empty.

---

AttrInputParameters^Required

public IResolvable AttrInputParameters { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute InputParameters: The settings of the input parameters for the rule.

---

AttrMaximumExecutionFrequency^Required

public IResolvable AttrMaximumExecutionFrequency { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.

Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours

---

AttrRegionIdsScope^Required

public IResolvable AttrRegionIdsScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.

---

AttrResourceGroupIdsScope^Required

public IResolvable AttrResourceGroupIdsScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.

---

AttrResourceTypesScope^Required

public IResolvable AttrResourceTypesScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.

---

AttrRiskLevel^Required

public IResolvable AttrRiskLevel { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute RiskLevel: The risk level of the resources that are not compliant with the rule.

Valid values: 1: critical 2: warning 3: info

---

AttrRuleName^Required

public IResolvable AttrRuleName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute RuleName: The name of the rule.

---

AttrSourceIdentifier^Required

public IResolvable AttrSourceIdentifier { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SourceIdentifier: The identifier of the rule.

For a managed rule, the value is the name of the managed rule. For a custom rule, the value is the ARN of the custom rule

---

AttrSourceOwner^Required

public IResolvable AttrSourceOwner { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.

Valid values: CUSTOM_FC: The rule is a custom rule and you own the rule. ALIYUN: The rule is a managed rule and Alibaba Cloud owns the rule

---

AttrTagKeyScope^Required

public IResolvable AttrTagKeyScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.

---

AttrTagValueScope^Required

public IResolvable AttrTagValueScope { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.

---

Structs