Enforce Resource Compliance via CreateConfigRule API - Cloud Config - Alibaba Cloud - Cloud Config

Creates a rule based on a template or creates a custom rule based on Function Compute to check the compliance of resources. After a rule is created, it automatically performs an evaluation. Cloud Config then automatically triggers evaluations based on the trigger mechanism of the rule. You can also manually trigger evaluations.

Operation description

Limits

You can create up to 200 rules for each account.

Background information

Cloud Config supports the following methods to create rules:

Create a rule based on a template

A rule template is a rule function that Cloud Config has built in Function Compute. You can use a rule template to quickly create a rule. For more information about rules, see Definition and running principle of rules.
Create a rule based on Function Compute

A custom function rule is a custom rule whose code is hosted in a function of Function Compute. If the preset rule templates of Cloud Config cannot meet your compliance requirements, you can write function code to perform compliance checks in complex scenarios. For more information about custom function rules, see Definition and running principle of custom function rules.

Operation description

This topic provides an example of how to create a rule by using the rule template "required-tags". The response shows that the rule is created, and the rule ID is cr-5772ba41209e007b****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:CreateConfigRule

create

*Rule

acs:config:*:{#accountId}:rule/*

None

Request parameters

Parameter	Type	Required	Description	Example
TagKeyScope `deprecated`	string	No	[Deprecated] Use the `TagsScope` parameter instead. The rule applies only to resources that have the specified tag keys. Note This parameter applies only to managed rules. You must set both `TagKeyScope` and `TagValueScope`.	ECS
TagValueScope `deprecated`	string	No	[Deprecated] Use the `TagsScope` parameter instead. The rule applies only to resources that have the specified tag values. Note This parameter applies only to rule templates. You must set both `TagKeyScope` and `TagValueScope`.	test
TagKeyLogicScope	string	No	The logical relationship when the `TagsScope` parameter has multiple values. For example, if the `TagsScope` parameter is set to `"TagsScope.1.TagKey":"a","TagsScope.1.TagValue":"a","TagsScope.2.TagKey":"b","TagsScope.2.TagValue":"b"` and this parameter is set to `AND`, the rule applies only to resources that have both the `a:a` and `b:b` tags. If this parameter is not specified, the default logic `OR` is used. This parameter can also be used with the deprecated `TagKeyScope` parameter (not recommended). For example, if the `TagKeyScope` parameter is set to `ECS,OSS` and this parameter is set to `AND`, the rule applies only to resources that have both the `ECS` and `OSS` tags. Valid values: AND: The AND logical operator. OR: The OR logical operator. Valid values: OR : The OR logical operator. AND : The AND logical operator.	AND
TagsScope	array<object>	No	The tag scope.
	object	No
TagKey	string	No	The tag key.	key-1
TagValue	string	No	The tag value.	value-1
ExcludeTagsScope	array<object>	No	The excluded tag scope.
	object	No
TagKey	string	No	The tag key.	key-2
TagValue	string	No	The tag value.	value-2
Description	string	No	The description of the rule.	You can define up to 6 tag groups. If a resource has all specified tags, the resource is considered "compliant"
SourceOwner	string	Yes	The type of the rule to create. Valid values: ALIYUN: rule template. CUSTOM_FC: custom Function Compute rule. CUSTOM_CONFIGURATION: custom condition rule. Valid values: CUSTOM_CONFIGURATION : custom condition rule. ALIYUN : rule template. CUSTOM_FC : custom Function Compute rule.	ALIYUN
MaximumExecutionFrequency	string	No	The execution frequency of the rule. Valid values: One_Hour: 1 hour. Three_Hours: 3 hours. Six_Hours: 6 hours. Twelve_Hours: 12 hours. TwentyFour_Hours (default): 24 hours. Note This parameter is required when ConfigRuleTriggerTypes is set to ScheduledNotification. Valid values: Twelve_Hours : 12 hours. Three_Hours : 3 hours. Six_Hours : 6 hours. One_Hour : 1 hour. TwentyFour_Hours : 24 hours.	One_Hour
Conditions	string	No	The conditions of the custom condition rule, in JSON format.	{"ComplianceConditions":"{\"operator\":\"and\",\"children\":[{\"operator\":\"StringEquals\",\"featurePath\":\"$.Status\",\"desired\":\"1\",\"featureSource\":\"CONFIGURATION\"}]}"}
RegionIdsScope	string	No	The rule applies only to resources in the specified region IDs. Separate multiple region IDs with commas (,). Note This parameter applies only to rule templates.	cn-hangzhou
ExcludeRegionIdsScope	string	No	The rule does not apply to resources in the specified regions. Resources in those regions are not evaluated. Separate multiple region IDs with commas (,).	cn-shanghai
ResourceGroupIdsScope	string	No	The rule applies only to resources in the specified resource group IDs. Separate multiple resource group IDs with commas (,). Note This parameter applies only to rule templates.	rg-aekzc7r7rhx****
ExcludeResourceGroupIdsScope	string	No	The rule does not apply to resources in the specified resource group IDs. Resources in those resource groups are not evaluated. Separate multiple resource group IDs with commas (,).	rg-bnczc6r7rml****
InputParameters	object	No	The input parameters of the rule. You can obtain the input parameters by calling the GetManagedRule operation. Check the `CompulsoryInputParameterDetails` and `OptionalInputParameterDetails` parameters for required and optional parameters. The input parameters are in the format of `{"Parameter 1 name":"Parameter 1 value","Parameter 2 name":"Parameter 2 value"}`.	{"key1":"value1","key2":"value2"}
ResourceIdsScope	string	No	The rule applies only to the specified resource IDs. Separate multiple resource IDs with commas (,).	lb-5cmbowstbkss9ta03****
ExcludeResourceIdsScope	string	No	The rule does not apply to the specified resource IDs. The specified resources are not evaluated. Separate multiple resource IDs with commas (,). Note This parameter applies only to rule templates.	lb-t4nbowvtbkss7t326****
SourceIdentifier	string	Yes	The identity of the rule template. If `SourceOwner` is set to `ALIYUN`, set this parameter to the identity of the rule template, such as `required-tags`. Note For information about how to query rule template identities, see Rule template list. If `SourceOwner` is set to `CUSTOM_CONFIGURATION`, set this parameter to `acs-config-configuration`. If `SourceOwner` is set to `CUSTOM_FC`, set this parameter to the Alibaba Cloud Resource Name (ARN) of the function in Function Compute. The ARN is in the format of `acs:fc:region:accountId:services/service name.LATEST/functions/functionName`, such as `acs:fc:cn-hangzhou:120886317861**:services/service-test.LATEST/functions/config-test`. Note** For information about how to obtain the function ARN, see ListFunctions.	required-tags
ConfigRuleTriggerTypes	string	Yes	The trigger mechanism of the rule. Valid values: ConfigurationItemChangeNotification: configuration change. ScheduledNotification: periodic execution. Note If the rule includes both trigger mechanisms, separate them with a comma (,).	ConfigurationItemChangeNotification
ConfigRuleName	string	Yes	The name of the rule.	required-tags
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `ClientToken` parameter supports only ASCII characters and cannot exceed 64 characters in length.	1594295238-f9361358-5843-4294-8d30-b5183fac****
ResourceTypesScope	array	Yes	The resource types to be evaluated by the rule. The actual parameter format is a comma-separated string (for example, ACS::ECS::Instance,ACS::RDS::DBInstance). JSON arrays or indexed parameters in the format of ResourceTypesScope.1 are not supported.	ACS::ECS::Instance
	string	No	The resource types to be evaluated by the rule. Separate multiple resource types with commas (,).	ACS::ECS::Instance
RiskLevel	integer	Yes	The risk level of the rule. Valid values: 1: high risk. 2: medium risk. 3: low risk. Valid values: 1 : high risk. 2 : medium risk. 3 : low risk.	1
ExtendContent	string	No	The extended content. Currently, this parameter is used only to set the trigger time for the 24-hour periodic trigger.	{"fixedHour":"13"}
Tag	array<object>	No	The tags of the created rule.
	object	No	The tags of the resource. You can add up to 20 tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys.	key-1
Value	string	No	The tag value of the resource. You can specify up to 20 tag values.	value-1
ResourceNameScope	string	No	The rule applies only to resources with the specified resource name.	i-xxx

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	The response parameters.
ConfigRuleId	string	The rule ID.	cr-5772ba41209e007b****
RequestId	string	The request ID.	6EC7AED1-172F-42AE-9C12-295BC2ADB751

Examples

Success response

JSON format

{
  "ConfigRuleId": "cr-5772ba41209e007b****",
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ExceedMaxRuleCount	The maximum number of rules is exceeded.
400	ConfigRuleNotExists	The ConfigRule does not exist.	The rule does not exist.
400	ConfigRuleExists	The ConfigRule already exists.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.