Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::Config::Rule.

Initializers

import { Rule } from '@alicloud/ros-cdk-config'
new Rule(scope: Construct, id: string, props: RuleProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: RuleProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrConfigRuleArn^Required

public readonly attrConfigRuleArn: string | IResolvable;

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

Attribute ConfigRuleArn: config rule arn.

attrConfigRuleId^Required

public readonly attrConfigRuleId: string | IResolvable;

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

Attribute ConfigRuleId: The ID of the rule.

attrConfigRuleTriggerTypes^Required

public readonly attrConfigRuleTriggerTypes: string | IResolvable;

• Type: string | @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.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

Attribute Description: The description of the rule.

attrEventSource^Required

public readonly attrEventSource: string | IResolvable;

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

Attribute EventSource: The event source of the rule.

attrExcludeResourceIdsScope^Required

public readonly attrExcludeResourceIdsScope: string | IResolvable;

• Type: string | @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^Required

public readonly attrInputParameters: string | IResolvable;

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

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

attrMaximumExecutionFrequency^Required

public readonly attrMaximumExecutionFrequency: string | IResolvable;

• Type: string | @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

attrRegionIdsScope^Required

public readonly attrRegionIdsScope: string | IResolvable;

• Type: string | @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^Required

public readonly attrResourceGroupIdsScope: string | IResolvable;

• Type: string | @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^Required

public readonly attrResourceTypesScope: string | IResolvable;

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

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

attrRiskLevel^Required

public readonly attrRiskLevel: string | IResolvable;

• Type: string | @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

attrRuleName^Required

public readonly attrRuleName: string | IResolvable;

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

Attribute RuleName: The name of the rule.

attrSourceIdentifier^Required

public readonly attrSourceIdentifier: string | IResolvable;

• Type: string | @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

attrSourceOwner^Required

public readonly attrSourceOwner: string | IResolvable;

• Type: string | @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

attrTagKeyScope^Required

public readonly attrTagKeyScope: string | IResolvable;

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

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

attrTagValueScope^Required

public readonly attrTagValueScope: string | IResolvable;

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

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

props^Required

public readonly props: RuleProps;

• Type: RuleProps

Structs