IRule
Represents a Rule.
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node for this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
attrConfigRuleArn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConfigRuleArn: config rule arn. |
attrConfigRuleId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConfigRuleId: The ID of the rule. |
attrConfigRuleTriggerTypes | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConfigRuleTriggerTypes: The trigger type of the rule. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the rule. |
attrEventSource | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EventSource: The event source of the rule. |
attrExcludeResourceIdsScope | 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InputParameters: The settings of the input parameters for the rule. |
attrMaximumExecutionFrequency | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations. |
attrRegionIdsScope | 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 | 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule. |
attrRiskLevel | 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. |
attrRuleName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RuleName: The name of the rule. |
attrSourceIdentifier | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceIdentifier: The identifier of the rule. |
attrSourceOwner | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule. |
attrTagKeyScope | 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 | 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 | RuleProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node for this construct.
envRequired
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.
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
attrConfigRuleArnRequired
public java.lang.Object getAttrConfigRuleArn();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConfigRuleArn: config rule arn.
attrConfigRuleIdRequired
public java.lang.Object getAttrConfigRuleId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConfigRuleId: The ID of the rule.
attrConfigRuleTriggerTypesRequired
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.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the rule.
attrEventSourceRequired
public java.lang.Object getAttrEventSource();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EventSource: The event source of the rule.
attrExcludeResourceIdsScopeRequired
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.
attrInputParametersRequired
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.
attrMaximumExecutionFrequencyRequired
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
attrRegionIdsScopeRequired
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.
attrResourceGroupIdsScopeRequired
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.
attrResourceTypesScopeRequired
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.
attrRiskLevelRequired
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
attrRuleNameRequired
public java.lang.Object getAttrRuleName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RuleName: The name of the rule.
attrSourceIdentifierRequired
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
attrSourceOwnerRequired
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
attrTagKeyScopeRequired
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.
attrTagValueScopeRequired
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.
propsRequired
public RuleProps getProps();
- Type: RuleProps