Rule

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

Initializers

import com.aliyun.ros.cdk.config.Rule;
Rule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No 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.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`configRuleTriggerTypes`^Required

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.

`resourceTypesScope`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

`riskLevel`^Required

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

`ruleName`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleName: The name of the rule.

`sourceIdentifier`^Required

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

`sourceOwner`^Required

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

`description`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the rule.

`excludeResourceIdsScope`^Optional

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.

`inputParameters`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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

`maximumExecutionFrequency`^Optional

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

`regionIdsScope`^Optional

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.

`resourceGroupIdsScope`^Optional

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.

`tagKeyLogicScope`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tagKeyLogicScope:.

`tagKeyScope`^Optional

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.

`tagValueScope`^Optional

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.

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`

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.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.config.Rule;
Rule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`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.
`attrConfigRuleArn`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ConfigRuleArn: config rule arn.
`attrConfigRuleId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ConfigRuleId: The ID of the rule.
`attrConfigRuleTriggerTypes`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ConfigRuleTriggerTypes: The trigger type of the rule.
`attrDescription`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Description: The description of the rule.
`attrEventSource`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EventSource: The event source of the rule.
`attrExcludeResourceIdsScope`	`com.aliyun.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`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute InputParameters: The settings of the input parameters for the rule.
`attrMaximumExecutionFrequency`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.
`attrRegionIdsScope`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
`attrResourceGroupIdsScope`	`com.aliyun.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`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.
`attrRiskLevel`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RiskLevel: The risk level of the resources that are not compliant with the rule.
`attrRuleName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RuleName: The name of the rule.
`attrSourceIdentifier`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SourceIdentifier: The identifier of the rule.
`attrSourceOwner`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.
`attrTagKeyScope`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
`attrTagValueScope`	`com.aliyun.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 getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrConfigRuleArn`^Required

public IResolvable getAttrConfigRuleArn();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigRuleArn: config rule arn.

`attrConfigRuleId`^Required

public IResolvable getAttrConfigRuleId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigRuleId: The ID of the rule.

`attrConfigRuleTriggerTypes`^Required

public IResolvable getAttrConfigRuleTriggerTypes();

Type: com.aliyun.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 getAttrDescription();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the rule.

`attrEventSource`^Required

public IResolvable getAttrEventSource();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EventSource: The event source of the rule.

`attrExcludeResourceIdsScope`^Required

public IResolvable getAttrExcludeResourceIdsScope();

Type: com.aliyun.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 getAttrInputParameters();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrMaximumExecutionFrequency`^Required

public IResolvable getAttrMaximumExecutionFrequency();

Type: com.aliyun.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 getAttrRegionIdsScope();

Type: com.aliyun.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 getAttrResourceGroupIdsScope();

Type: com.aliyun.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 getAttrResourceTypesScope();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrRiskLevel`^Required

public IResolvable getAttrRiskLevel();

Type: com.aliyun.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 getAttrRuleName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RuleName: The name of the rule.

`attrSourceIdentifier`^Required

public IResolvable getAttrSourceIdentifier();

Type: com.aliyun.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 getAttrSourceOwner();

Type: com.aliyun.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 getAttrTagKeyScope();

Type: com.aliyun.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 getAttrTagValueScope();

Type: com.aliyun.ros.cdk.core.IResolvable

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

Structs

Rule

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

configRuleTriggerTypesRequired

resourceTypesScopeRequired

riskLevelRequired

ruleNameRequired

sourceIdentifierRequired

sourceOwnerRequired

descriptionOptional

excludeResourceIdsScopeOptional

inputParametersOptional

maximumExecutionFrequencyOptional

regionIdsScopeOptional

resourceGroupIdsScopeOptional

tagKeyLogicScopeOptional

tagKeyScopeOptional

tagValueScopeOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata

Static Functions

isConstruct