Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::Config::Rule.

Initializers

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

Scope^Required

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

Id^Required

• Type: string

Props^Required

• Type: RuleProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

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

IsConstruct

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

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

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

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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

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 object AttrConfigRuleArn { get; }

• Type: object

Attribute ConfigRuleArn: config rule arn.

AttrConfigRuleId^Required

public object AttrConfigRuleId { get; }

• Type: object

Attribute ConfigRuleId: The ID of the rule.

AttrConfigRuleTriggerTypes^Required

public object AttrConfigRuleTriggerTypes { get; }

• Type: object

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 object AttrDescription { get; }

• Type: object

Attribute Description: The description of the rule.

AttrEventSource^Required

public object AttrEventSource { get; }

• Type: object

Attribute EventSource: The event source of the rule.

AttrExcludeResourceIdsScope^Required

public object AttrExcludeResourceIdsScope { get; }

• Type: object

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 object AttrInputParameters { get; }

• Type: object

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

AttrMaximumExecutionFrequency^Required

public object AttrMaximumExecutionFrequency { get; }

• Type: object

Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.

Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours

AttrRegionIdsScope^Required

public object AttrRegionIdsScope { get; }

• Type: object

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

AttrResourceGroupIdsScope^Required

public object AttrResourceGroupIdsScope { get; }

• Type: object

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

AttrResourceTypesScope^Required

public object AttrResourceTypesScope { get; }

• Type: object

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

AttrRiskLevel^Required

public object AttrRiskLevel { get; }

• Type: object

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 object AttrRuleName { get; }

• Type: object

Attribute RuleName: The name of the rule.

AttrSourceIdentifier^Required

public object AttrSourceIdentifier { get; }

• Type: object

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 object AttrSourceOwner { get; }

• Type: object

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 object AttrTagKeyScope { get; }

• Type: object

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

AttrTagValueScope^Required

public object AttrTagValueScope { get; }

• Type: object

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

Props^Required

public RuleProps Props { get; }

• Type: RuleProps

Structs