Skip to content

Rule

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

Initializers 

import { Rule } from '@alicloud/ros-cdk-config'
new Rule(scope: Construct, id: string, props: RuleProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props RuleProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { Rule } from '@alicloud/ros-cdk-config'
Rule.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

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

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrConfigRuleArnRequired 

public readonly attrConfigRuleArn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ConfigRuleArn: config rule arn.

attrConfigRuleIdRequired 

public readonly attrConfigRuleId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ConfigRuleId: The ID of the rule.

attrConfigRuleTriggerTypesRequired 

public readonly attrConfigRuleTriggerTypes: IResolvable;
  • Type: @alicloud/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 readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the rule.

attrEventSourceRequired 

public readonly attrEventSource: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EventSource: The event source of the rule.

attrExcludeResourceIdsScopeRequired 

public readonly attrExcludeResourceIdsScope: IResolvable;
  • Type: @alicloud/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 readonly attrInputParameters: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrMaximumExecutionFrequencyRequired 

public readonly attrMaximumExecutionFrequency: IResolvable;
  • Type: @alicloud/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 readonly attrRegionIdsScope: IResolvable;
  • Type: @alicloud/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 readonly attrResourceGroupIdsScope: IResolvable;
  • Type: @alicloud/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 readonly attrResourceTypesScope: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrRiskLevelRequired 

public readonly attrRiskLevel: IResolvable;
  • Type: @alicloud/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 readonly attrRuleName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RuleName: The name of the rule.

attrSourceIdentifierRequired 

public readonly attrSourceIdentifier: IResolvable;
  • Type: @alicloud/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 readonly attrSourceOwner: IResolvable;
  • Type: @alicloud/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 readonly attrTagKeyScope: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrTagValueScopeRequired 

public readonly attrTagValueScope: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

Structs