IRule
Represents a Rule.
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node for this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
attr_config_rule_arn | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ConfigRuleArn: config rule arn. |
attr_config_rule_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ConfigRuleId: The ID of the rule. |
attr_config_rule_trigger_types | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ConfigRuleTriggerTypes: The trigger type of the rule. |
attr_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Description: The description of the rule. |
attr_event_source | typing.Union[str, ros_cdk_core.IResolvable] | Attribute EventSource: The event source of the rule. |
attr_exclude_resource_ids_scope | typing.Union[str, 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. |
attr_input_parameters | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InputParameters: The settings of the input parameters for the rule. |
attr_maximum_execution_frequency | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations. |
attr_region_ids_scope | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules. |
attr_resource_group_ids_scope | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules. |
attr_resource_types_scope | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule. |
attr_risk_level | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RiskLevel: The risk level of the resources that are not compliant with the rule. |
attr_rule_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RuleName: The name of the rule. |
attr_source_identifier | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SourceIdentifier: The identifier of the rule. |
attr_source_owner | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule. |
attr_tag_key_scope | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules. |
attr_tag_value_scope | typing.Union[str, 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
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node for this construct.
envRequired
env: IResourceEnvironment
- Type: 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
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
attr_config_rule_arnRequired
attr_config_rule_arn: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ConfigRuleArn: config rule arn.
attr_config_rule_idRequired
attr_config_rule_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ConfigRuleId: The ID of the rule.
attr_config_rule_trigger_typesRequired
attr_config_rule_trigger_types: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
attr_descriptionRequired
attr_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Description: The description of the rule.
attr_event_sourceRequired
attr_event_source: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute EventSource: The event source of the rule.
attr_exclude_resource_ids_scopeRequired
attr_exclude_resource_ids_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
attr_input_parametersRequired
attr_input_parameters: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InputParameters: The settings of the input parameters for the rule.
attr_maximum_execution_frequencyRequired
attr_maximum_execution_frequency: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.
Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours
attr_region_ids_scopeRequired
attr_region_ids_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
attr_resource_group_ids_scopeRequired
attr_resource_group_ids_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.
attr_resource_types_scopeRequired
attr_resource_types_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.
attr_risk_levelRequired
attr_risk_level: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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
attr_rule_nameRequired
attr_rule_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RuleName: The name of the rule.
attr_source_identifierRequired
attr_source_identifier: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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
attr_source_ownerRequired
attr_source_owner: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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
attr_tag_key_scopeRequired
attr_tag_key_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
attr_tag_value_scopeRequired
attr_tag_value_scope: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.
propsRequired
props: RuleProps
- Type: RuleProps