Skip to content

RuleProps

Properties for defining a Rule.

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

Initializer 

import com.aliyun.ros.cdk.config.RuleProps;
RuleProps.builder()
    .configRuleTriggerTypes(java.lang.String)
    .configRuleTriggerTypes(IResolvable)
    .resourceTypesScope(IResolvable)
    .resourceTypesScope(java.util.List<java.lang.String)
    .resourceTypesScope(IResolvable>)
    .riskLevel(java.lang.Number)
    .riskLevel(IResolvable)
    .ruleName(java.lang.String)
    .ruleName(IResolvable)
    .sourceIdentifier(java.lang.String)
    .sourceIdentifier(IResolvable)
    .sourceOwner(java.lang.String)
    .sourceOwner(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .excludeResourceIdsScope(java.lang.String)
//  .excludeResourceIdsScope(IResolvable)
//  .inputParameters(IResolvable)
//  .inputParameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .maximumExecutionFrequency(java.lang.String)
//  .maximumExecutionFrequency(IResolvable)
//  .regionIdsScope(java.lang.String)
//  .regionIdsScope(IResolvable)
//  .resourceGroupIdsScope(java.lang.String)
//  .resourceGroupIdsScope(IResolvable)
//  .tagKeyLogicScope(java.lang.String)
//  .tagKeyLogicScope(IResolvable)
//  .tagKeyScope(java.lang.String)
//  .tagKeyScope(IResolvable)
//  .tagValueScope(java.lang.String)
//  .tagValueScope(IResolvable)
    .build();

Properties

Name Type Description
configRuleTriggerTypes java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property configRuleTriggerTypes: The trigger type of the rule.
resourceTypesScope com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property resourceTypesScope: The types of the resources to be evaluated against the rule.
riskLevel java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property riskLevel: The risk level of the resources that are not compliant with the rule.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: The name of the rule.
sourceIdentifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceIdentifier: The identifier of the rule.
sourceOwner java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the rule.
excludeResourceIdsScope java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property inputParameters: The settings of the input parameters for the rule.
maximumExecutionFrequency java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property maximumExecutionFrequency: The frequency of the compliance evaluations.
regionIdsScope java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property regionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
resourceGroupIdsScope java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tagKeyLogicScope:.
tagKeyScope java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
tagValueScope java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.

configRuleTriggerTypesRequired 

public java.lang.Object getConfigRuleTriggerTypes();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceTypesScope();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

riskLevelRequired 

public java.lang.Object getRiskLevel();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getRuleName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleName: The name of the rule.

sourceIdentifierRequired 

public java.lang.Object getSourceIdentifier();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSourceOwner();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the rule.

excludeResourceIdsScopeOptional 

public java.lang.Object getExcludeResourceIdsScope();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInputParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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

maximumExecutionFrequencyOptional 

public java.lang.Object getMaximumExecutionFrequency();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRegionIdsScope();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupIdsScope();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTagKeyLogicScope();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tagKeyLogicScope:.

tagKeyScopeOptional 

public java.lang.Object getTagKeyScope();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

tagValueScopeOptional 

public java.lang.Object getTagValueScope();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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