Rule
- Implements: IRule
This class encapsulates and extends the ROS resource type ALIYUN::Config::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
- Type: RuleProps
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. |
FetchCondition | No description. |
FetchDependency | No description. |
FetchResourceDesc | 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.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession
The synthesis session.
AddCondition
func AddCondition(condition RosCondition)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition
AddCount
func AddCount(count interface{})
- Type: interface{}
AddDependency
func AddDependency(resource Resource)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource
AddResourceDesc
func AddResourceDesc(desc *string)
- Type: *string
ApplyRemovalPolicy
func ApplyRemovalPolicy(policy RemovalPolicy)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy
FetchCondition
func FetchCondition() RosCondition
FetchDependency
func FetchDependency() *[]*string
FetchResourceDesc
func FetchResourceDesc() *string
GetAtt
func GetAtt(name *string) IResolvable
- Type: *string
SetMetadata
func SetMetadata(key *string, value interface{})
- Type: *string
- 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.
- Type: interface{}
Properties
| Name | Type | Description |
|---|---|---|
Node | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode | The construct tree node associated with this construct. |
Env | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment | The environment this resource belongs to. |
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 | interface{} | Attribute ConfigRuleArn: config rule arn. |
AttrConfigRuleId | interface{} | Attribute ConfigRuleId: The ID of the rule. |
AttrConfigRuleTriggerTypes | interface{} | Attribute ConfigRuleTriggerTypes: The trigger type of the rule. |
AttrDescription | interface{} | Attribute Description: The description of the rule. |
AttrEventSource | interface{} | Attribute EventSource: The event source of the rule. |
AttrExcludeResourceIdsScope | interface{} | 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 | interface{} | Attribute InputParameters: The settings of the input parameters for the rule. |
AttrMaximumExecutionFrequency | interface{} | Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations. |
AttrRegionIdsScope | interface{} | Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules. |
AttrResourceGroupIdsScope | interface{} | Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules. |
AttrResourceTypesScope | interface{} | Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule. |
AttrRiskLevel | interface{} | Attribute RiskLevel: The risk level of the resources that are not compliant with the rule. |
AttrRuleName | interface{} | Attribute RuleName: The name of the rule. |
AttrSourceIdentifier | interface{} | Attribute SourceIdentifier: The identifier of the rule. |
AttrSourceOwner | interface{} | Attribute SourceOwner: Specifies whether you or Alibaba Cloud owns and manages the rule. |
AttrTagKeyScope | interface{} | Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules. |
AttrTagValueScope | interface{} | Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules. |
Props | RuleProps | No description. |
NodeRequired
func Node() ConstructNode
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode
The construct tree node associated with this construct.
EnvRequired
func Env() IResourceEnvironment
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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.
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() interface{}
- Type: interface{}
Attribute ConfigRuleArn: config rule arn.
AttrConfigRuleIdRequired
func AttrConfigRuleId() interface{}
- Type: interface{}
Attribute ConfigRuleId: The ID of the rule.
AttrConfigRuleTriggerTypesRequired
func AttrConfigRuleTriggerTypes() interface{}
- Type: interface{}
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() interface{}
- Type: interface{}
Attribute Description: The description of the rule.
AttrEventSourceRequired
func AttrEventSource() interface{}
- Type: interface{}
Attribute EventSource: The event source of the rule.
AttrExcludeResourceIdsScopeRequired
func AttrExcludeResourceIdsScope() interface{}
- Type: interface{}
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() interface{}
- Type: interface{}
Attribute InputParameters: The settings of the input parameters for the rule.
AttrMaximumExecutionFrequencyRequired
func AttrMaximumExecutionFrequency() interface{}
- Type: interface{}
Attribute MaximumExecutionFrequency: The frequency of the compliance evaluations.
Valid values: One_Hour Three_Hours Six_Hours Twelve_Hours TwentyFour_Hours
AttrRegionIdsScopeRequired
func AttrRegionIdsScope() interface{}
- Type: interface{}
Attribute RegionIdsScope: The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceGroupIdsScopeRequired
func AttrResourceGroupIdsScope() interface{}
- Type: interface{}
Attribute ResourceGroupIdsScope: The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.
AttrResourceTypesScopeRequired
func AttrResourceTypesScope() interface{}
- Type: interface{}
Attribute ResourceTypesScope: The types of the resources to be evaluated against the rule.
AttrRiskLevelRequired
func AttrRiskLevel() interface{}
- Type: interface{}
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() interface{}
- Type: interface{}
Attribute RuleName: The name of the rule.
AttrSourceIdentifierRequired
func AttrSourceIdentifier() interface{}
- Type: interface{}
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() interface{}
- Type: interface{}
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() interface{}
- Type: interface{}
Attribute TagKeyScope: The rule monitors the tag key, only applies to rules created based on managed rules.
AttrTagValueScopeRequired
func AttrTagValueScope() interface{}
- Type: interface{}
Attribute TagValueScope: The rule monitors the tag value, only applies to rules created based on managed rules.
PropsRequired
func Props() RuleProps
- Type: RuleProps