Skip to content

RuleProps

Properties for defining a Rule.

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

Initializer 

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

Properties

Name Type Description
configRuleTriggerTypes string | @alicloud/ros-cdk-core.IResolvable Property configRuleTriggerTypes: The trigger type of the rule.
resourceTypesScope @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property resourceTypesScope: The types of the resources to be evaluated against the rule.
riskLevel number | @alicloud/ros-cdk-core.IResolvable Property riskLevel: The risk level of the resources that are not compliant with the rule.
ruleName string | @alicloud/ros-cdk-core.IResolvable Property ruleName: The name of the rule.
sourceIdentifier string | @alicloud/ros-cdk-core.IResolvable Property sourceIdentifier: The identifier of the rule.
sourceOwner string | @alicloud/ros-cdk-core.IResolvable Property sourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the rule.
excludeResourceIdsScope string | @alicloud/ros-cdk-core.IResolvable Property 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.
inputParameters @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property inputParameters: The settings of the input parameters for the rule.
maximumExecutionFrequency string | @alicloud/ros-cdk-core.IResolvable Property maximumExecutionFrequency: The frequency of the compliance evaluations.
regionIdsScope string | @alicloud/ros-cdk-core.IResolvable Property regionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
resourceGroupIdsScope string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.
tagKeyLogicScope string | @alicloud/ros-cdk-core.IResolvable Property tagKeyLogicScope:.
tagKeyScope string | @alicloud/ros-cdk-core.IResolvable Property tagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
tagValueScope string | @alicloud/ros-cdk-core.IResolvable Property tagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.

configRuleTriggerTypesRequired 

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

Property configRuleTriggerTypes: The trigger type of the rule.

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

resourceTypesScopeRequired 

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

Property resourceTypesScope: The types of the resources to be evaluated against the rule.

riskLevelRequired 

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

Property riskLevel: The risk level of the resources that are not compliant with the rule.

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

ruleNameRequired 

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

Property ruleName: The name of the rule.

sourceIdentifierRequired 

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

Property 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

sourceOwnerRequired 

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

Property 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

descriptionOptional 

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

Property description: The description of the rule.

excludeResourceIdsScopeOptional 

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

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

inputParametersOptional 

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

Property inputParameters: The settings of the input parameters for the rule.

maximumExecutionFrequencyOptional 

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

Property maximumExecutionFrequency: The frequency of the compliance evaluations.

Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours

regionIdsScopeOptional 

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

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

resourceGroupIdsScopeOptional 

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

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

tagKeyLogicScopeOptional 

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

Property tagKeyLogicScope:.

tagKeyScopeOptional 

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

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

tagValueScopeOptional 

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

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