Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. config
  6. Rule
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.config.Rule

volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Configuration audit rule

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const example = new volcenginecc.config.Rule("example", {
    ruleTemplateId: "00000000-0000-0000-0000-000000000000",
    ruleName: "ccapi-config-rule-full",
    description: "ccapi config rule full",
    triggers: [{
        trigger_type: "Periodic",
        maximum_execution_frequency: "TwentyFourHours",
    }],
    inputParameters: "{}",
    scope: {
        resource_types: {
            include: ["Volcengine::Redis::AllowList"],
        },
        resource_ids: {
            include: ["example-resource-id"],
        },
        regions: {
            include: ["cn-beijing"],
        },
        projects: {
            include: ["default"],
        },
        tags: {
            include: [{
                key: "k1",
                value: "v1",
            }],
        },
    },
    riskLevel: "Medium",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.config.Rule("example",
    rule_template_id="00000000-0000-0000-0000-000000000000",
    rule_name="ccapi-config-rule-full",
    description="ccapi config rule full",
    triggers=[{
        "trigger_type": "Periodic",
        "maximum_execution_frequency": "TwentyFourHours",
    }],
    input_parameters="{}",
    scope={
        "resource_types": {
            "include": ["Volcengine::Redis::AllowList"],
        },
        "resource_ids": {
            "include": ["example-resource-id"],
        },
        "regions": {
            "include": ["cn-beijing"],
        },
        "projects": {
            "include": ["default"],
        },
        "tags": {
            "include": [{
                "key": "k1",
                "value": "v1",
            }],
        },
    },
    risk_level="Medium")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := config.NewRule(ctx, "example", &config.RuleArgs{
			RuleTemplateId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			RuleName:       pulumi.String("ccapi-config-rule-full"),
			Description:    pulumi.String("ccapi config rule full"),
			Triggers: config.RuleTriggerArray{
				&config.RuleTriggerArgs{
					Trigger_type:                "Periodic",
					Maximum_execution_frequency: "TwentyFourHours",
				},
			},
			InputParameters: pulumi.String("{}"),
			Scope: &config.RuleScopeArgs{
				Resource_types: map[string]interface{}{
					"include": []string{
						"Volcengine::Redis::AllowList",
					},
				},
				Resource_ids: map[string]interface{}{
					"include": []string{
						"example-resource-id",
					},
				},
				Regions: &config.RuleScopeRegionsArgs{
					Include: []string{
						"cn-beijing",
					},
				},
				Projects: &config.RuleScopeProjectsArgs{
					Include: []string{
						"default",
					},
				},
				Tags: &config.RuleScopeTagsArgs{
					Include: []map[string]interface{}{
						map[string]interface{}{
							"key":   "k1",
							"value": "v1",
						},
					},
				},
			},
			RiskLevel: pulumi.String("Medium"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var example = new Volcenginecc.Config.Rule("example", new()
    {
        RuleTemplateId = "00000000-0000-0000-0000-000000000000",
        RuleName = "ccapi-config-rule-full",
        Description = "ccapi config rule full",
        Triggers = new[]
        {
            new Volcenginecc.Config.Inputs.RuleTriggerArgs
            {
                Trigger_type = "Periodic",
                Maximum_execution_frequency = "TwentyFourHours",
            },
        },
        InputParameters = "{}",
        Scope = new Volcenginecc.Config.Inputs.RuleScopeArgs
        {
            Resource_types = 
            {
                { "include", new[]
                {
                    "Volcengine::Redis::AllowList",
                } },
            },
            Resource_ids = 
            {
                { "include", new[]
                {
                    "example-resource-id",
                } },
            },
            Regions = new Volcenginecc.Config.Inputs.RuleScopeRegionsArgs
            {
                Include = new[]
                {
                    "cn-beijing",
                },
            },
            Projects = new Volcenginecc.Config.Inputs.RuleScopeProjectsArgs
            {
                Include = new[]
                {
                    "default",
                },
            },
            Tags = new Volcenginecc.Config.Inputs.RuleScopeTagsArgs
            {
                Include = new[]
                {
                    
                    {
                        { "key", "k1" },
                        { "value", "v1" },
                    },
                },
            },
        },
        RiskLevel = "Medium",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.config.Rule;
import com.volcengine.volcenginecc.config.RuleArgs;
import com.pulumi.volcenginecc.config.inputs.RuleTriggerArgs;
import com.pulumi.volcenginecc.config.inputs.RuleScopeArgs;
import com.pulumi.volcenginecc.config.inputs.RuleScopeRegionsArgs;
import com.pulumi.volcenginecc.config.inputs.RuleScopeProjectsArgs;
import com.pulumi.volcenginecc.config.inputs.RuleScopeTagsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new Rule("example", RuleArgs.builder()
            .ruleTemplateId("00000000-0000-0000-0000-000000000000")
            .ruleName("ccapi-config-rule-full")
            .description("ccapi config rule full")
            .triggers(RuleTriggerArgs.builder()
                .trigger_type("Periodic")
                .maximum_execution_frequency("TwentyFourHours")
                .build())
            .inputParameters("{}")
            .scope(RuleScopeArgs.builder()
                .resource_types(Map.of("include", Arrays.asList("Volcengine::Redis::AllowList")))
                .resource_ids(Map.of("include", Arrays.asList("example-resource-id")))
                .regions(RuleScopeRegionsArgs.builder()
                    .include(Arrays.asList("cn-beijing"))
                    .build())
                .projects(RuleScopeProjectsArgs.builder()
                    .include(Arrays.asList("default"))
                    .build())
                .tags(RuleScopeTagsArgs.builder()
                    .include(Arrays.asList(Map.ofEntries(
                        Map.entry("key", "k1"),
                        Map.entry("value", "v1")
                    )))
                    .build())
                .build())
            .riskLevel("Medium")
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:config:Rule
    properties:
      ruleTemplateId: 00000000-0000-0000-0000-000000000000
      ruleName: ccapi-config-rule-full
      description: ccapi config rule full
      triggers:
        - trigger_type: Periodic
          maximum_execution_frequency: TwentyFourHours
      inputParameters: '{}'
      scope:
        resource_types:
          include:
            - Volcengine::Redis::AllowList
        resource_ids:
          include:
            - example-resource-id
        regions:
          include:
            - cn-beijing
        projects:
          include:
            - default
        tags:
          include:
            - key: k1
              value: v1
      riskLevel: Medium

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_config_rule" "example" {
  rule_template_id = "00000000-0000-0000-0000-000000000000"
  rule_name        = "ccapi-config-rule-full"
  description      = "ccapi config rule full"
  triggers {
    trigger_type                = "Periodic"
    maximum_execution_frequency = "TwentyFourHours"
  }
  input_parameters = "{}"
  scope = {
    resource_types = {
      "include" = ["Volcengine::Redis::AllowList"]
    }
    resource_ids = {
      "include" = ["example-resource-id"]
    }
    regions = {
      include = ["cn-beijing"]
    }
    projects = {
      include = ["default"]
    }
    tags = {
      include = [{
        "key"   = "k1"
        "value" = "v1"
      }]
    }
  }
  risk_level = "Medium"
}

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         input_parameters: Optional[str] = None,
         risk_level: Optional[str] = None,
         rule_name: Optional[str] = None,
         rule_template_id: Optional[str] = None,
         scope: Optional[RuleScopeArgs] = None,
         triggers: Optional[Sequence[RuleTriggerArgs]] = None,
         rule_status: Optional[str] = None,
         start_rule_evaluation: Optional[bool] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

    type: volcenginecc:config:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_config_rule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleruleResourceResourceFromConfigrule = new Volcenginecc.Config.Rule("exampleruleResourceResourceFromConfigrule", new()
{
    Description = "string",
    InputParameters = "string",
    RiskLevel = "string",
    RuleName = "string",
    RuleTemplateId = "string",
    Scope = new Volcenginecc.Config.Inputs.RuleScopeArgs
    {
        Projects = new Volcenginecc.Config.Inputs.RuleScopeProjectsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        Regions = new Volcenginecc.Config.Inputs.RuleScopeRegionsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        ResourceIds = new Volcenginecc.Config.Inputs.RuleScopeResourceIdsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        ResourceTypes = new Volcenginecc.Config.Inputs.RuleScopeResourceTypesArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        Tags = new Volcenginecc.Config.Inputs.RuleScopeTagsArgs
        {
            Excludes = new[]
            {
                new Volcenginecc.Config.Inputs.RuleScopeTagsExcludeArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
            Includes = new[]
            {
                new Volcenginecc.Config.Inputs.RuleScopeTagsIncludeArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
    },
    Triggers = new[]
    {
        new Volcenginecc.Config.Inputs.RuleTriggerArgs
        {
            MaximumExecutionFrequency = "string",
            TriggerType = "string",
        },
    },
    RuleStatus = "string",
    StartRuleEvaluation = false,
});

    example, err := config.NewRule(ctx, "exampleruleResourceResourceFromConfigrule", &config.RuleArgs{
	Description:     pulumi.String("string"),
	InputParameters: pulumi.String("string"),
	RiskLevel:       pulumi.String("string"),
	RuleName:        pulumi.String("string"),
	RuleTemplateId:  pulumi.String("string"),
	Scope: &config.RuleScopeArgs{
		Projects: &config.RuleScopeProjectsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Regions: &config.RuleScopeRegionsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ResourceIds: &config.RuleScopeResourceIdsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ResourceTypes: &config.RuleScopeResourceTypesArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Tags: &config.RuleScopeTagsArgs{
			Excludes: config.RuleScopeTagsExcludeArray{
				&config.RuleScopeTagsExcludeArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			Includes: config.RuleScopeTagsIncludeArray{
				&config.RuleScopeTagsIncludeArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
	},
	Triggers: config.RuleTriggerArray{
		&config.RuleTriggerArgs{
			MaximumExecutionFrequency: pulumi.String("string"),
			TriggerType:               pulumi.String("string"),
		},
	},
	RuleStatus:          pulumi.String("string"),
	StartRuleEvaluation: pulumi.Bool(false),
})

    resource "volcenginecc_config_rule" "exampleruleResourceResourceFromConfigrule" {
  lifecycle {
    create_before_destroy = true
  }
  description      = "string"
  input_parameters = "string"
  risk_level       = "string"
  rule_name        = "string"
  rule_template_id = "string"
  scope = {
    projects = {
      excludes = ["string"]
      includes = ["string"]
    }
    regions = {
      excludes = ["string"]
      includes = ["string"]
    }
    resource_ids = {
      excludes = ["string"]
      includes = ["string"]
    }
    resource_types = {
      excludes = ["string"]
      includes = ["string"]
    }
    tags = {
      excludes = [{
        key   = "string"
        value = "string"
      }]
      includes = [{
        key   = "string"
        value = "string"
      }]
    }
  }
  triggers {
    maximum_execution_frequency = "string"
    trigger_type                = "string"
  }
  rule_status           = "string"
  start_rule_evaluation = false
}

    var exampleruleResourceResourceFromConfigrule = new com.volcengine.volcenginecc.config.Rule("exampleruleResourceResourceFromConfigrule", com.volcengine.volcenginecc.config.RuleArgs.builder()
    .description("string")
    .inputParameters("string")
    .riskLevel("string")
    .ruleName("string")
    .ruleTemplateId("string")
    .scope(RuleScopeArgs.builder()
        .projects(RuleScopeProjectsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .regions(RuleScopeRegionsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .resourceIds(RuleScopeResourceIdsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .resourceTypes(RuleScopeResourceTypesArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .tags(RuleScopeTagsArgs.builder()
            .excludes(RuleScopeTagsExcludeArgs.builder()
                .key("string")
                .value("string")
                .build())
            .includes(RuleScopeTagsIncludeArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .build())
    .triggers(RuleTriggerArgs.builder()
        .maximumExecutionFrequency("string")
        .triggerType("string")
        .build())
    .ruleStatus("string")
    .startRuleEvaluation(false)
    .build());

    examplerule_resource_resource_from_configrule = volcenginecc.config.Rule("exampleruleResourceResourceFromConfigrule",
    description="string",
    input_parameters="string",
    risk_level="string",
    rule_name="string",
    rule_template_id="string",
    scope={
        "projects": {
            "excludes": ["string"],
            "includes": ["string"],
        },
        "regions": {
            "excludes": ["string"],
            "includes": ["string"],
        },
        "resource_ids": {
            "excludes": ["string"],
            "includes": ["string"],
        },
        "resource_types": {
            "excludes": ["string"],
            "includes": ["string"],
        },
        "tags": {
            "excludes": [{
                "key": "string",
                "value": "string",
            }],
            "includes": [{
                "key": "string",
                "value": "string",
            }],
        },
    },
    triggers=[{
        "maximum_execution_frequency": "string",
        "trigger_type": "string",
    }],
    rule_status="string",
    start_rule_evaluation=False)

    const exampleruleResourceResourceFromConfigrule = new volcenginecc.config.Rule("exampleruleResourceResourceFromConfigrule", {
    description: "string",
    inputParameters: "string",
    riskLevel: "string",
    ruleName: "string",
    ruleTemplateId: "string",
    scope: {
        projects: {
            excludes: ["string"],
            includes: ["string"],
        },
        regions: {
            excludes: ["string"],
            includes: ["string"],
        },
        resourceIds: {
            excludes: ["string"],
            includes: ["string"],
        },
        resourceTypes: {
            excludes: ["string"],
            includes: ["string"],
        },
        tags: {
            excludes: [{
                key: "string",
                value: "string",
            }],
            includes: [{
                key: "string",
                value: "string",
            }],
        },
    },
    triggers: [{
        maximumExecutionFrequency: "string",
        triggerType: "string",
    }],
    ruleStatus: "string",
    startRuleEvaluation: false,
});

    type: volcenginecc:config:Rule
properties:
    description: string
    inputParameters: string
    riskLevel: string
    ruleName: string
    ruleStatus: string
    ruleTemplateId: string
    scope:
        projects:
            excludes:
                - string
            includes:
                - string
        regions:
            excludes:
                - string
            includes:
                - string
        resourceIds:
            excludes:
                - string
            includes:
                - string
        resourceTypes:
            excludes:
                - string
            includes:
                - string
        tags:
            excludes:
                - key: string
                  value: string
            includes:
                - key: string
                  value: string
    startRuleEvaluation: false
    triggers:
        - maximumExecutionFrequency: string
          triggerType: string

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Rule resource accepts the following input properties:

    Description string
    Rule description
    InputParameters string
    Rule runtime parameters (JSON string)
    RiskLevel string
    Risk level. Options: Low, Medium, High
    RuleName string
    Rule name
    RuleTemplateId string
    Rule template ID
    Scope Volcengine.RuleScope
    Resource evaluation scope
    Triggers List<Volcengine.RuleTrigger>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    RuleStatus string
    Rule enable status. Options: Enabled, Disabled
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    Description string
    Rule description
    InputParameters string
    Rule runtime parameters (JSON string)
    RiskLevel string
    Risk level. Options: Low, Medium, High
    RuleName string
    Rule name
    RuleTemplateId string
    Rule template ID
    Scope RuleScopeArgs
    Resource evaluation scope
    Triggers []RuleTriggerArgs
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    RuleStatus string
    Rule enable status. Options: Enabled, Disabled
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    description string
    Rule description
    input_parameters string
    Rule runtime parameters (JSON string)
    risk_level string
    Risk level. Options: Low, Medium, High
    rule_name string
    Rule name
    rule_template_id string
    Rule template ID
    scope object
    Resource evaluation scope
    triggers list(object)
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    rule_status string
    Rule enable status. Options: Enabled, Disabled
    start_rule_evaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    description String
    Rule description
    inputParameters String
    Rule runtime parameters (JSON string)
    riskLevel String
    Risk level. Options: Low, Medium, High
    ruleName String
    Rule name
    ruleTemplateId String
    Rule template ID
    scope RuleScope
    Resource evaluation scope
    triggers List<RuleTrigger>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ruleStatus String
    Rule enable status. Options: Enabled, Disabled
    startRuleEvaluation Boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    description string
    Rule description
    inputParameters string
    Rule runtime parameters (JSON string)
    riskLevel string
    Risk level. Options: Low, Medium, High
    ruleName string
    Rule name
    ruleTemplateId string
    Rule template ID
    scope RuleScope
    Resource evaluation scope
    triggers RuleTrigger[]
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ruleStatus string
    Rule enable status. Options: Enabled, Disabled
    startRuleEvaluation boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    description str
    Rule description
    input_parameters str
    Rule runtime parameters (JSON string)
    risk_level str
    Risk level. Options: Low, Medium, High
    rule_name str
    Rule name
    rule_template_id str
    Rule template ID
    scope RuleScopeArgs
    Resource evaluation scope
    triggers Sequence[RuleTriggerArgs]
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    rule_status str
    Rule enable status. Options: Enabled, Disabled
    start_rule_evaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    description String
    Rule description
    inputParameters String
    Rule runtime parameters (JSON string)
    riskLevel String
    Risk level. Options: Low, Medium, High
    ruleName String
    Rule name
    ruleTemplateId String
    Rule template ID
    scope Property Map
    Resource evaluation scope
    triggers List<Property Map>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ruleStatus String
    Rule enable status. Options: Enabled, Disabled
    startRuleEvaluation Boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

    CreatedTime string
    Creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    Rule ID
    CreatedTime string
    Creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    Rule ID
    created_time string
    Creation time
    id string
    The provider-assigned unique ID for this managed resource.
    rule_id string
    Rule ID
    createdTime String
    Creation time
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    Rule ID
    createdTime string
    Creation time
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    Rule ID
    created_time str
    Creation time
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    Rule ID
    createdTime String
    Creation time
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    Rule ID

    Look up Existing Rule Resource

    Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        input_parameters: Optional[str] = None,
        risk_level: Optional[str] = None,
        rule_id: Optional[str] = None,
        rule_name: Optional[str] = None,
        rule_status: Optional[str] = None,
        rule_template_id: Optional[str] = None,
        scope: Optional[RuleScopeArgs] = None,
        start_rule_evaluation: Optional[bool] = None,
        triggers: Optional[Sequence[RuleTriggerArgs]] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:config:Rule    get:      id: ${id}
    import {
  to = volcenginecc_config_rule.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedTime string
    Creation time
    Description string
    Rule description
    InputParameters string
    Rule runtime parameters (JSON string)
    RiskLevel string
    Risk level. Options: Low, Medium, High
    RuleId string
    Rule ID
    RuleName string
    Rule name
    RuleStatus string
    Rule enable status. Options: Enabled, Disabled
    RuleTemplateId string
    Rule template ID
    Scope Volcengine.RuleScope
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    Triggers List<Volcengine.RuleTrigger>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    CreatedTime string
    Creation time
    Description string
    Rule description
    InputParameters string
    Rule runtime parameters (JSON string)
    RiskLevel string
    Risk level. Options: Low, Medium, High
    RuleId string
    Rule ID
    RuleName string
    Rule name
    RuleStatus string
    Rule enable status. Options: Enabled, Disabled
    RuleTemplateId string
    Rule template ID
    Scope RuleScopeArgs
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    Triggers []RuleTriggerArgs
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    created_time string
    Creation time
    description string
    Rule description
    input_parameters string
    Rule runtime parameters (JSON string)
    risk_level string
    Risk level. Options: Low, Medium, High
    rule_id string
    Rule ID
    rule_name string
    Rule name
    rule_status string
    Rule enable status. Options: Enabled, Disabled
    rule_template_id string
    Rule template ID
    scope object
    Resource evaluation scope
    start_rule_evaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers list(object)
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime String
    Creation time
    description String
    Rule description
    inputParameters String
    Rule runtime parameters (JSON string)
    riskLevel String
    Risk level. Options: Low, Medium, High
    ruleId String
    Rule ID
    ruleName String
    Rule name
    ruleStatus String
    Rule enable status. Options: Enabled, Disabled
    ruleTemplateId String
    Rule template ID
    scope RuleScope
    Resource evaluation scope
    startRuleEvaluation Boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers List<RuleTrigger>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime string
    Creation time
    description string
    Rule description
    inputParameters string
    Rule runtime parameters (JSON string)
    riskLevel string
    Risk level. Options: Low, Medium, High
    ruleId string
    Rule ID
    ruleName string
    Rule name
    ruleStatus string
    Rule enable status. Options: Enabled, Disabled
    ruleTemplateId string
    Rule template ID
    scope RuleScope
    Resource evaluation scope
    startRuleEvaluation boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers RuleTrigger[]
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    created_time str
    Creation time
    description str
    Rule description
    input_parameters str
    Rule runtime parameters (JSON string)
    risk_level str
    Risk level. Options: Low, Medium, High
    rule_id str
    Rule ID
    rule_name str
    Rule name
    rule_status str
    Rule enable status. Options: Enabled, Disabled
    rule_template_id str
    Rule template ID
    scope RuleScopeArgs
    Resource evaluation scope
    start_rule_evaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers Sequence[RuleTriggerArgs]
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    createdTime String
    Creation time
    description String
    Rule description
    inputParameters String
    Rule runtime parameters (JSON string)
    riskLevel String
    Risk level. Options: Low, Medium, High
    ruleId String
    Rule ID
    ruleName String
    Rule name
    ruleStatus String
    Rule enable status. Options: Enabled, Disabled
    ruleTemplateId String
    Rule template ID
    scope Property Map
    Resource evaluation scope
    startRuleEvaluation Boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers List<Property Map>
    Rule trigger configuration Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    Supporting Types

    RuleScope, RuleScopeArgs

    Projects RuleScopeProjects
    Project filter scope
    Regions RuleScopeRegions
    Resource region list
    ResourceIds RuleScopeResourceIds
    Resource ID list
    ResourceTypes RuleScopeResourceTypes
    Resource type scope
    Tags RuleScopeTags
    Resource tag list
    projects object
    Project filter scope
    regions object
    Resource region list
    resource_ids object
    Resource ID list
    resource_types object
    Resource type scope
    tags object
    Resource tag list
    projects RuleScopeProjects
    Project filter scope
    regions RuleScopeRegions
    Resource region list
    resourceIds RuleScopeResourceIds
    Resource ID list
    resourceTypes RuleScopeResourceTypes
    Resource type scope
    tags RuleScopeTags
    Resource tag list
    projects RuleScopeProjects
    Project filter scope
    regions RuleScopeRegions
    Resource region list
    resourceIds RuleScopeResourceIds
    Resource ID list
    resourceTypes RuleScopeResourceTypes
    Resource type scope
    tags RuleScopeTags
    Resource tag list
    projects RuleScopeProjects
    Project filter scope
    regions RuleScopeRegions
    Resource region list
    resource_ids RuleScopeResourceIds
    Resource ID list
    resource_types RuleScopeResourceTypes
    Resource type scope
    tags RuleScopeTags
    Resource tag list
    projects Property Map
    Project filter scope
    regions Property Map
    Resource region list
    resourceIds Property Map
    Resource ID list
    resourceTypes Property Map
    Resource type scope
    tags Property Map
    Resource tag list

    RuleScopeProjects, RuleScopeProjectsArgs

    Excludes List<string>
    Exclusion list
    Includes List<string>
    Inclusion list
    Excludes []string
    Exclusion list
    Includes []string
    Inclusion list
    excludes list(string)
    Exclusion list
    includes list(string)
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list
    excludes string[]
    Exclusion list
    includes string[]
    Inclusion list
    excludes Sequence[str]
    Exclusion list
    includes Sequence[str]
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list

    RuleScopeRegions, RuleScopeRegionsArgs

    Excludes List<string>
    Exclusion list
    Includes List<string>
    Inclusion list
    Excludes []string
    Exclusion list
    Includes []string
    Inclusion list
    excludes list(string)
    Exclusion list
    includes list(string)
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list
    excludes string[]
    Exclusion list
    includes string[]
    Inclusion list
    excludes Sequence[str]
    Exclusion list
    includes Sequence[str]
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list

    RuleScopeResourceIds, RuleScopeResourceIdsArgs

    Excludes List<string>
    Exclusion list
    Includes List<string>
    Inclusion list
    Excludes []string
    Exclusion list
    Includes []string
    Inclusion list
    excludes list(string)
    Exclusion list
    includes list(string)
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list
    excludes string[]
    Exclusion list
    includes string[]
    Inclusion list
    excludes Sequence[str]
    Exclusion list
    includes Sequence[str]
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list

    RuleScopeResourceTypes, RuleScopeResourceTypesArgs

    Excludes List<string>
    Exclusion list
    Includes List<string>
    Inclusion list
    Excludes []string
    Exclusion list
    Includes []string
    Inclusion list
    excludes list(string)
    Exclusion list
    includes list(string)
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list
    excludes string[]
    Exclusion list
    includes string[]
    Inclusion list
    excludes Sequence[str]
    Exclusion list
    includes Sequence[str]
    Inclusion list
    excludes List<String>
    Exclusion list
    includes List<String>
    Inclusion list

    RuleScopeTags, RuleScopeTagsArgs

    Excludes List<Volcengine.RuleScopeTagsExclude>
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Includes List<Volcengine.RuleScopeTagsInclude>
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Excludes []RuleScopeTagsExclude
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Includes []RuleScopeTagsInclude
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    excludes list(object)
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    includes list(object)
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    excludes List<RuleScopeTagsExclude>
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    includes List<RuleScopeTagsInclude>
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    excludes RuleScopeTagsExclude[]
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    includes RuleScopeTagsInclude[]
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    excludes Sequence[RuleScopeTagsExclude]
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    includes Sequence[RuleScopeTagsInclude]
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    excludes List<Property Map>
    Exclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    includes List<Property Map>
    Inclusion list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    RuleScopeTagsExclude, RuleScopeTagsExcludeArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    RuleScopeTagsInclude, RuleScopeTagsIncludeArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    RuleTrigger, RuleTriggerArgs

    MaximumExecutionFrequency string
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    TriggerType string
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    MaximumExecutionFrequency string
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    TriggerType string
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    maximum_execution_frequency string
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    trigger_type string
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    maximumExecutionFrequency String
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    triggerType String
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    maximumExecutionFrequency string
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    triggerType string
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    maximum_execution_frequency str
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    trigger_type str
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual
    maximumExecutionFrequency String
    Maximum execution frequency. Options: OneHour, ThreeHours, SixHours, TwelveHours, TwentyFourHours
    triggerType String
    Trigger type. Options: ConfigurationItemChange, Periodic, Manual

    Import

    $ pulumi import volcenginecc:config/rule:Rule example "rule_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.60
    published on Thursday, Sep 3, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial