tencentcloud.getConfigRules

tencentcloud 1.82.93, May 11 26

Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

Schema (JSON)

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

Query all config rules

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const example = tencentcloud.getConfigRules({});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_config_rules()

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetConfigRules(ctx, &tencentcloud.GetConfigRulesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetConfigRules.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetConfigRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = TencentcloudFunctions.getConfigRules(GetConfigRulesArgs.builder()
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getConfigRules
      arguments: {}

Example coming soon!

Query config rules by name

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const example = tencentcloud.getConfigRules({
    ruleName: "cam-user-mfa-check",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_config_rules(rule_name="cam-user-mfa-check")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetConfigRules(ctx, &tencentcloud.GetConfigRulesArgs{
			RuleName: pulumi.StringRef("cam-user-mfa-check"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetConfigRules.Invoke(new()
    {
        RuleName = "cam-user-mfa-check",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetConfigRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = TencentcloudFunctions.getConfigRules(GetConfigRulesArgs.builder()
            .ruleName("cam-user-mfa-check")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getConfigRules
      arguments:
        ruleName: cam-user-mfa-check

Example coming soon!

Query config rules by filters

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const example = tencentcloud.getConfigRules({
    riskLevels: [
        1,
        2,
    ],
    state: "ACTIVE",
    complianceResults: ["NON_COMPLIANT"],
    orderType: "desc",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_config_rules(risk_levels=[
        1,
        2,
    ],
    state="ACTIVE",
    compliance_results=["NON_COMPLIANT"],
    order_type="desc")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetConfigRules(ctx, &tencentcloud.GetConfigRulesArgs{
			RiskLevels: []float64{
				1,
				2,
			},
			State: pulumi.StringRef("ACTIVE"),
			ComplianceResults: []string{
				"NON_COMPLIANT",
			},
			OrderType: pulumi.StringRef("desc"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetConfigRules.Invoke(new()
    {
        RiskLevels = new[]
        {
            1,
            2,
        },
        State = "ACTIVE",
        ComplianceResults = new[]
        {
            "NON_COMPLIANT",
        },
        OrderType = "desc",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetConfigRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = TencentcloudFunctions.getConfigRules(GetConfigRulesArgs.builder()
            .riskLevels(            
                1,
                2)
            .state("ACTIVE")
            .complianceResults("NON_COMPLIANT")
            .orderType("desc")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getConfigRules
      arguments:
        riskLevels:
          - 1
          - 2
        state: ACTIVE
        complianceResults:
          - NON_COMPLIANT
        orderType: desc

Example coming soon!

Using getConfigRules

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfigRules(args: GetConfigRulesArgs, opts?: InvokeOptions): Promise<GetConfigRulesResult>
function getConfigRulesOutput(args: GetConfigRulesOutputArgs, opts?: InvokeOptions): Output<GetConfigRulesResult>

def get_config_rules(compliance_results: Optional[Sequence[str]] = None,
                     id: Optional[str] = None,
                     order_type: Optional[str] = None,
                     result_output_file: Optional[str] = None,
                     risk_levels: Optional[Sequence[float]] = None,
                     rule_name: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetConfigRulesResult
def get_config_rules_output(compliance_results: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                     id: pulumi.Input[Optional[str]] = None,
                     order_type: pulumi.Input[Optional[str]] = None,
                     result_output_file: pulumi.Input[Optional[str]] = None,
                     risk_levels: pulumi.Input[Optional[Sequence[pulumi.Input[float]]]] = None,
                     rule_name: pulumi.Input[Optional[str]] = None,
                     state: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetConfigRulesResult]

func GetConfigRules(ctx *Context, args *GetConfigRulesArgs, opts ...InvokeOption) (*GetConfigRulesResult, error)
func GetConfigRulesOutput(ctx *Context, args *GetConfigRulesOutputArgs, opts ...InvokeOption) GetConfigRulesResultOutput

> Note: This function is named GetConfigRules in the Go SDK.

public static class GetConfigRules 
{
    public static Task<GetConfigRulesResult> InvokeAsync(GetConfigRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigRulesResult> Invoke(GetConfigRulesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConfigRulesResult> getConfigRules(GetConfigRulesArgs args, InvokeOptions options)
public static Output<GetConfigRulesResult> getConfigRules(GetConfigRulesArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getConfigRules:getConfigRules
  arguments:
    # arguments dictionary

data "tencentcloud_getconfigrules" "name" {
    # arguments
}

The following arguments are supported:

ComplianceResults List<string>: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
Id string
OrderType string: Sort type by rule name. Valid values: desc (descending), asc (ascending).
ResultOutputFile string: Used to save results.
RiskLevels List<double>: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
RuleName string: Rule name for filtering.
State string: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

ComplianceResults []string: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
Id string
OrderType string: Sort type by rule name. Valid values: desc (descending), asc (ascending).
ResultOutputFile string: Used to save results.
RiskLevels []float64: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
RuleName string: Rule name for filtering.
State string: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

compliance_results list(string): Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
id string
order_type string: Sort type by rule name. Valid values: desc (descending), asc (ascending).
result_output_file string: Used to save results.
risk_levels list(number): Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
rule_name string: Rule name for filtering.
state string: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

complianceResults List<String>: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
id String
orderType String: Sort type by rule name. Valid values: desc (descending), asc (ascending).
resultOutputFile String: Used to save results.
riskLevels List<Double>: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName String: Rule name for filtering.
state String: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

complianceResults string[]: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
id string
orderType string: Sort type by rule name. Valid values: desc (descending), asc (ascending).
resultOutputFile string: Used to save results.
riskLevels number[]: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName string: Rule name for filtering.
state string: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

compliance_results Sequence[str]: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
id str
order_type str: Sort type by rule name. Valid values: desc (descending), asc (ascending).
result_output_file str: Used to save results.
risk_levels Sequence[float]: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
rule_name str: Rule name for filtering.
state str: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

complianceResults List<String>: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
id String
orderType String: Sort type by rule name. Valid values: desc (descending), asc (ascending).
resultOutputFile String: Used to save results.
riskLevels List<Number>: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName String: Rule name for filtering.
state String: Rule state for filtering. Valid values: ACTIVE, UN_ACTIVE.

getConfigRules Result

The following output properties are available:

Id string
RuleLists List<GetConfigRulesRuleList>: Config rule list.
ComplianceResults List<string>: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
OrderType string
ResultOutputFile string
RiskLevels List<double>: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
RuleName string: Rule name.
State string

Id string
RuleLists []GetConfigRulesRuleList: Config rule list.
ComplianceResults []string: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
OrderType string
ResultOutputFile string
RiskLevels []float64: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
RuleName string: Rule name.
State string

id string
rule_lists list(object): Config rule list.
compliance_results list(string): Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
order_type string
result_output_file string
risk_levels list(number): Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
rule_name string: Rule name.
state string

id String
ruleLists List<GetConfigRulesRuleList>: Config rule list.
complianceResults List<String>: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
orderType String
resultOutputFile String
riskLevels List<Double>: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
ruleName String: Rule name.
state String

id string
ruleLists GetConfigRulesRuleList[]: Config rule list.
complianceResults string[]: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
orderType string
resultOutputFile string
riskLevels number[]: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
ruleName string: Rule name.
state string

id str
rule_lists Sequence[GetConfigRulesRuleList]: Config rule list.
compliance_results Sequence[str]: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
order_type str
result_output_file str
risk_levels Sequence[float]: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
rule_name str: Rule name.
state str

id String
ruleLists List<Property Map>: Config rule list.
complianceResults List<String>: Compliance result. Valid values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE.
orderType String
resultOutputFile String
riskLevels List<Number>: Risk level. Valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
ruleName String: Rule name.
state String

Supporting Types

GetConfigRulesRuleList

CompliancePackId string: Compliance pack ID.
CompliancePackName string: Compliance pack name.
ComplianceResult string: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
ConfigRuleId string: Config rule ID.
ConfigRuleInvokedTime string: Rule evaluation time.
CreateTime string: Creation time.
Description string: Rule description.
Identifier string: Rule identifier.
IdentifierType string: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
Labels List<string>: Rule label list.
ResourceTypes List<string>: Supported resource type list.
RiskLevel double: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
RuleName string: Rule name for filtering.
ServiceFunction string: Corresponding service function.
Status string: Rule status. Valid values: ACTIVE, NO_ACTIVE.

CompliancePackId string: Compliance pack ID.
CompliancePackName string: Compliance pack name.
ComplianceResult string: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
ConfigRuleId string: Config rule ID.
ConfigRuleInvokedTime string: Rule evaluation time.
CreateTime string: Creation time.
Description string: Rule description.
Identifier string: Rule identifier.
IdentifierType string: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
Labels []string: Rule label list.
ResourceTypes []string: Supported resource type list.
RiskLevel float64: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
RuleName string: Rule name for filtering.
ServiceFunction string: Corresponding service function.
Status string: Rule status. Valid values: ACTIVE, NO_ACTIVE.

compliance_pack_id string: Compliance pack ID.
compliance_pack_name string: Compliance pack name.
compliance_result string: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
config_rule_id string: Config rule ID.
config_rule_invoked_time string: Rule evaluation time.
create_time string: Creation time.
description string: Rule description.
identifier string: Rule identifier.
identifier_type string: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
labels list(string): Rule label list.
resource_types list(string): Supported resource type list.
risk_level number: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
rule_name string: Rule name for filtering.
service_function string: Corresponding service function.
status string: Rule status. Valid values: ACTIVE, NO_ACTIVE.

compliancePackId String: Compliance pack ID.
compliancePackName String: Compliance pack name.
complianceResult String: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
configRuleId String: Config rule ID.
configRuleInvokedTime String: Rule evaluation time.
createTime String: Creation time.
description String: Rule description.
identifier String: Rule identifier.
identifierType String: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
labels List<String>: Rule label list.
resourceTypes List<String>: Supported resource type list.
riskLevel Double: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName String: Rule name for filtering.
serviceFunction String: Corresponding service function.
status String: Rule status. Valid values: ACTIVE, NO_ACTIVE.

compliancePackId string: Compliance pack ID.
compliancePackName string: Compliance pack name.
complianceResult string: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
configRuleId string: Config rule ID.
configRuleInvokedTime string: Rule evaluation time.
createTime string: Creation time.
description string: Rule description.
identifier string: Rule identifier.
identifierType string: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
labels string[]: Rule label list.
resourceTypes string[]: Supported resource type list.
riskLevel number: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName string: Rule name for filtering.
serviceFunction string: Corresponding service function.
status string: Rule status. Valid values: ACTIVE, NO_ACTIVE.

compliance_pack_id str: Compliance pack ID.
compliance_pack_name str: Compliance pack name.
compliance_result str: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
config_rule_id str: Config rule ID.
config_rule_invoked_time str: Rule evaluation time.
create_time str: Creation time.
description str: Rule description.
identifier str: Rule identifier.
identifier_type str: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
labels Sequence[str]: Rule label list.
resource_types Sequence[str]: Supported resource type list.
risk_level float: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
rule_name str: Rule name for filtering.
service_function str: Corresponding service function.
status str: Rule status. Valid values: ACTIVE, NO_ACTIVE.

compliancePackId String: Compliance pack ID.
compliancePackName String: Compliance pack name.
complianceResult String: Compliance result list for filtering. Valid values: COMPLIANT, NON_COMPLIANT.
configRuleId String: Config rule ID.
configRuleInvokedTime String: Rule evaluation time.
createTime String: Creation time.
description String: Rule description.
identifier String: Rule identifier.
identifierType String: Rule type. Valid values: CUSTOMIZE (custom rule), SYSTEM (managed rule).
labels List<String>: Rule label list.
resourceTypes List<String>: Supported resource type list.
riskLevel Number: Risk level list for filtering. Valid values: 1 (high risk), 2 (medium risk), 3 (low risk).
ruleName String: Rule name for filtering.
serviceFunction String: Corresponding service function.
status String: Rule status. Valid values: ACTIVE, NO_ACTIVE.