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 "github.com/alibabacloud-go/ros-cdk/alicloudroscdkconfig"
alicloudroscdkconfig.NewRule(scope Construct, id *string, props RuleProps, enableResourcePropertyConstraint *bool) Rule
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props RuleProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

idRequired

  • Type: *string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: *bool

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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


AddCondition

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

GetAtt

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

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

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkconfig"
alicloudroscdkconfig.Rule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Ref *string No description.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this resource is defined.
Resource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource No description.
AttrConfigRuleArn github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ConfigRuleArn: config rule arn.
AttrConfigRuleId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ConfigRuleId: The ID of the rule.
AttrConfigRuleTriggerTypes github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ConfigRuleTriggerTypes: The trigger type of the rule.
AttrDescription github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Description: The description of the rule.
AttrEventSource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute EventSource: The event source of the rule.
AttrExcludeResourceIdsScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute InputParameters: The settings of the input parameters for the rule.
AttrMaximumExecutionFrequency github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.
AttrRegionIdsScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceGroupIdsScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceTypesScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.
AttrRiskLevel github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute RiskLevel: The risk level of the resources that are not compliant with the rule.
AttrRuleName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute RuleName: The name of the rule.
AttrSourceIdentifier github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SourceIdentifier: The identifier of the rule.
AttrSourceOwner github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule.
AttrTagKeyScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
AttrTagValueScope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


RefRequired

func Ref() *string
  • Type: *string

StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.


ResourceOptional

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrConfigRuleArnRequired

func AttrConfigRuleArn() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute ConfigRuleArn: config rule arn.


AttrConfigRuleIdRequired

func AttrConfigRuleId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute ConfigRuleId: The ID of the rule.


AttrConfigRuleTriggerTypesRequired

func AttrConfigRuleTriggerTypes() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func AttrDescription() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Description: The description of the rule.


AttrEventSourceRequired

func AttrEventSource() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute EventSource: The event source of the rule.


AttrExcludeResourceIdsScopeRequired

func AttrExcludeResourceIdsScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func AttrInputParameters() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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


AttrMaximumExecutionFrequencyRequired

func AttrMaximumExecutionFrequency() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.

Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours


AttrRegionIdsScopeRequired

func AttrRegionIdsScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.


AttrResourceGroupIdsScopeRequired

func AttrResourceGroupIdsScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.


AttrResourceTypesScopeRequired

func AttrResourceTypesScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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


AttrRiskLevelRequired

func AttrRiskLevel() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func AttrRuleName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute RuleName: The name of the rule.


AttrSourceIdentifierRequired

func AttrSourceIdentifier() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func AttrSourceOwner() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func AttrTagKeyScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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


AttrTagValueScopeRequired

func AttrTagValueScope() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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


Structs