Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::Config::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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 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 java.lang.Object getAttrConfigRuleArn();

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

Attribute ConfigRuleArn: config rule arn.

attrConfigRuleId^Required

public java.lang.Object getAttrConfigRuleId();

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

Attribute ConfigRuleId: The ID of the rule.

attrConfigRuleTriggerTypes^Required

public java.lang.Object getAttrConfigRuleTriggerTypes();

• Type: java.lang.String OR 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 java.lang.Object getAttrDescription();

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

Attribute Description: The description of the rule.

attrEventSource^Required

public java.lang.Object getAttrEventSource();

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

Attribute EventSource: The event source of the rule.

attrExcludeResourceIdsScope^Required

public java.lang.Object getAttrExcludeResourceIdsScope();

• Type: java.lang.String OR 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 java.lang.Object getAttrInputParameters();

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

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

attrMaximumExecutionFrequency^Required

public java.lang.Object getAttrMaximumExecutionFrequency();

• Type: java.lang.String OR 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 java.lang.Object getAttrRegionIdsScope();

• Type: java.lang.String OR 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 java.lang.Object getAttrResourceGroupIdsScope();

• Type: java.lang.String OR 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 java.lang.Object getAttrResourceTypesScope();

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

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

attrRiskLevel^Required

public java.lang.Object getAttrRiskLevel();

• Type: java.lang.String OR 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 java.lang.Object getAttrRuleName();

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

Attribute RuleName: The name of the rule.

attrSourceIdentifier^Required

public java.lang.Object getAttrSourceIdentifier();

• Type: java.lang.String OR 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 java.lang.Object getAttrSourceOwner();

• Type: java.lang.String OR 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 java.lang.Object getAttrTagKeyScope();

• Type: java.lang.String OR 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 java.lang.Object getAttrTagValueScope();

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

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

props^Required

public RuleProps getProps();

• Type: RuleProps

Structs