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

volcenginecc.config.GroupRule

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

    Configure audit account group rule

    Example Usage

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

const example = new volcenginecc.config.GroupRule("example", {
    accountGroupId: "00000000-0000-0000-0000-000000000000",
    ruleTemplateId: "00000000-0000-0000-0000-000000000000",
    ruleName: "ccapi-config-grouprule-full",
    description: "ccapi config group 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.GroupRule("example",
    account_group_id="00000000-0000-0000-0000-000000000000",
    rule_template_id="00000000-0000-0000-0000-000000000000",
    rule_name="ccapi-config-grouprule-full",
    description="ccapi config group 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.NewGroupRule(ctx, "example", &config.GroupRuleArgs{
			AccountGroupId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			RuleTemplateId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			RuleName:       pulumi.String("ccapi-config-grouprule-full"),
			Description:    pulumi.String("ccapi config group rule full"),
			Triggers: config.GroupRuleTriggerArray{
				&config.GroupRuleTriggerArgs{
					Trigger_type:                "Periodic",
					Maximum_execution_frequency: "TwentyFourHours",
				},
			},
			InputParameters: pulumi.String("{}"),
			Scope: &config.GroupRuleScopeArgs{
				Resource_types: map[string]interface{}{
					"include": []string{
						"Volcengine::Redis::AllowList",
					},
				},
				Resource_ids: map[string]interface{}{
					"include": []string{
						"example-resource-id",
					},
				},
				Regions: &config.GroupRuleScopeRegionsArgs{
					Include: []string{
						"cn-beijing",
					},
				},
				Projects: &config.GroupRuleScopeProjectsArgs{
					Include: []string{
						"default",
					},
				},
				Tags: &config.GroupRuleScopeTagsArgs{
					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.GroupRule("example", new()
    {
        AccountGroupId = "00000000-0000-0000-0000-000000000000",
        RuleTemplateId = "00000000-0000-0000-0000-000000000000",
        RuleName = "ccapi-config-grouprule-full",
        Description = "ccapi config group rule full",
        Triggers = new[]
        {
            new Volcenginecc.Config.Inputs.GroupRuleTriggerArgs
            {
                Trigger_type = "Periodic",
                Maximum_execution_frequency = "TwentyFourHours",
            },
        },
        InputParameters = "{}",
        Scope = new Volcenginecc.Config.Inputs.GroupRuleScopeArgs
        {
            Resource_types = 
            {
                { "include", new[]
                {
                    "Volcengine::Redis::AllowList",
                } },
            },
            Resource_ids = 
            {
                { "include", new[]
                {
                    "example-resource-id",
                } },
            },
            Regions = new Volcenginecc.Config.Inputs.GroupRuleScopeRegionsArgs
            {
                Include = new[]
                {
                    "cn-beijing",
                },
            },
            Projects = new Volcenginecc.Config.Inputs.GroupRuleScopeProjectsArgs
            {
                Include = new[]
                {
                    "default",
                },
            },
            Tags = new Volcenginecc.Config.Inputs.GroupRuleScopeTagsArgs
            {
                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.GroupRule;
import com.volcengine.volcenginecc.config.GroupRuleArgs;
import com.pulumi.volcenginecc.config.inputs.GroupRuleTriggerArgs;
import com.pulumi.volcenginecc.config.inputs.GroupRuleScopeArgs;
import com.pulumi.volcenginecc.config.inputs.GroupRuleScopeRegionsArgs;
import com.pulumi.volcenginecc.config.inputs.GroupRuleScopeProjectsArgs;
import com.pulumi.volcenginecc.config.inputs.GroupRuleScopeTagsArgs;
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 GroupRule("example", GroupRuleArgs.builder()
            .accountGroupId("00000000-0000-0000-0000-000000000000")
            .ruleTemplateId("00000000-0000-0000-0000-000000000000")
            .ruleName("ccapi-config-grouprule-full")
            .description("ccapi config group rule full")
            .triggers(GroupRuleTriggerArgs.builder()
                .trigger_type("Periodic")
                .maximum_execution_frequency("TwentyFourHours")
                .build())
            .inputParameters("{}")
            .scope(GroupRuleScopeArgs.builder()
                .resource_types(Map.of("include", Arrays.asList("Volcengine::Redis::AllowList")))
                .resource_ids(Map.of("include", Arrays.asList("example-resource-id")))
                .regions(GroupRuleScopeRegionsArgs.builder()
                    .include(Arrays.asList("cn-beijing"))
                    .build())
                .projects(GroupRuleScopeProjectsArgs.builder()
                    .include(Arrays.asList("default"))
                    .build())
                .tags(GroupRuleScopeTagsArgs.builder()
                    .include(Arrays.asList(Map.ofEntries(
                        Map.entry("key", "k1"),
                        Map.entry("value", "v1")
                    )))
                    .build())
                .build())
            .riskLevel("Medium")
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:config:GroupRule
    properties:
      accountGroupId: 00000000-0000-0000-0000-000000000000
      ruleTemplateId: 00000000-0000-0000-0000-000000000000
      ruleName: ccapi-config-grouprule-full
      description: ccapi config group 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_grouprule" "example" {
  account_group_id = "00000000-0000-0000-0000-000000000000"
  rule_template_id = "00000000-0000-0000-0000-000000000000"
  rule_name        = "ccapi-config-grouprule-full"
  description      = "ccapi config group 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 GroupRule Resource

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

    Constructor syntax

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

@overload
def GroupRule(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[GroupRuleScopeArgs] = None,
              triggers: Optional[Sequence[GroupRuleTriggerArgs]] = None,
              account_group_id: Optional[str] = None,
              rule_status: Optional[str] = None,
              start_rule_evaluation: Optional[bool] = None)
    func NewGroupRule(ctx *Context, name string, args GroupRuleArgs, opts ...ResourceOption) (*GroupRule, error)
    public GroupRule(string name, GroupRuleArgs args, CustomResourceOptions? opts = null)
    public GroupRule(String name, GroupRuleArgs args)
public GroupRule(String name, GroupRuleArgs args, CustomResourceOptions options)

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


    resource "volcenginecc_config_group_rule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GroupRuleArgs
    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 GroupRuleArgs
    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 GroupRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupRuleArgs
    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 groupRuleResource = new Volcenginecc.Config.GroupRule("groupRuleResource", new()
{
    Description = "string",
    InputParameters = "string",
    RiskLevel = "string",
    RuleName = "string",
    RuleTemplateId = "string",
    Scope = new Volcenginecc.Config.Inputs.GroupRuleScopeArgs
    {
        Projects = new Volcenginecc.Config.Inputs.GroupRuleScopeProjectsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        Regions = new Volcenginecc.Config.Inputs.GroupRuleScopeRegionsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        ResourceIds = new Volcenginecc.Config.Inputs.GroupRuleScopeResourceIdsArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        ResourceTypes = new Volcenginecc.Config.Inputs.GroupRuleScopeResourceTypesArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        Tags = new Volcenginecc.Config.Inputs.GroupRuleScopeTagsArgs
        {
            Excludes = new[]
            {
                new Volcenginecc.Config.Inputs.GroupRuleScopeTagsExcludeArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
            Includes = new[]
            {
                new Volcenginecc.Config.Inputs.GroupRuleScopeTagsIncludeArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
    },
    Triggers = new[]
    {
        new Volcenginecc.Config.Inputs.GroupRuleTriggerArgs
        {
            MaximumExecutionFrequency = "string",
            TriggerType = "string",
        },
    },
    AccountGroupId = "string",
    RuleStatus = "string",
    StartRuleEvaluation = false,
});

    example, err := config.NewGroupRule(ctx, "groupRuleResource", &config.GroupRuleArgs{
	Description:     pulumi.String("string"),
	InputParameters: pulumi.String("string"),
	RiskLevel:       pulumi.String("string"),
	RuleName:        pulumi.String("string"),
	RuleTemplateId:  pulumi.String("string"),
	Scope: &config.GroupRuleScopeArgs{
		Projects: &config.GroupRuleScopeProjectsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Regions: &config.GroupRuleScopeRegionsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ResourceIds: &config.GroupRuleScopeResourceIdsArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ResourceTypes: &config.GroupRuleScopeResourceTypesArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Tags: &config.GroupRuleScopeTagsArgs{
			Excludes: config.GroupRuleScopeTagsExcludeArray{
				&config.GroupRuleScopeTagsExcludeArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			Includes: config.GroupRuleScopeTagsIncludeArray{
				&config.GroupRuleScopeTagsIncludeArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
	},
	Triggers: config.GroupRuleTriggerArray{
		&config.GroupRuleTriggerArgs{
			MaximumExecutionFrequency: pulumi.String("string"),
			TriggerType:               pulumi.String("string"),
		},
	},
	AccountGroupId:      pulumi.String("string"),
	RuleStatus:          pulumi.String("string"),
	StartRuleEvaluation: pulumi.Bool(false),
})

    resource "volcenginecc_config_group_rule" "groupRuleResource" {
  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"
  }
  account_group_id      = "string"
  rule_status           = "string"
  start_rule_evaluation = false
}

    var groupRuleResource = new GroupRule("groupRuleResource", GroupRuleArgs.builder()
    .description("string")
    .inputParameters("string")
    .riskLevel("string")
    .ruleName("string")
    .ruleTemplateId("string")
    .scope(GroupRuleScopeArgs.builder()
        .projects(GroupRuleScopeProjectsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .regions(GroupRuleScopeRegionsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .resourceIds(GroupRuleScopeResourceIdsArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .resourceTypes(GroupRuleScopeResourceTypesArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .tags(GroupRuleScopeTagsArgs.builder()
            .excludes(GroupRuleScopeTagsExcludeArgs.builder()
                .key("string")
                .value("string")
                .build())
            .includes(GroupRuleScopeTagsIncludeArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .build())
    .triggers(GroupRuleTriggerArgs.builder()
        .maximumExecutionFrequency("string")
        .triggerType("string")
        .build())
    .accountGroupId("string")
    .ruleStatus("string")
    .startRuleEvaluation(false)
    .build());

    group_rule_resource = volcenginecc.config.GroupRule("groupRuleResource",
    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",
    }],
    account_group_id="string",
    rule_status="string",
    start_rule_evaluation=False)

    const groupRuleResource = new volcenginecc.config.GroupRule("groupRuleResource", {
    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",
    }],
    accountGroupId: "string",
    ruleStatus: "string",
    startRuleEvaluation: false,
});

    type: volcenginecc:config:GroupRule
properties:
    accountGroupId: string
    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

    GroupRule 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 GroupRule 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.GroupRuleScope
    Resource evaluation scope
    Triggers List<Volcengine.GroupRuleTrigger>
    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.
    AccountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    RuleStatus string
    Rule status. Options: Enabled, Disabled
    StartRuleEvaluation bool
    Whether to trigger rule re-evaluation. When 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 GroupRuleScopeArgs
    Resource evaluation scope
    Triggers []GroupRuleTriggerArgs
    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.
    AccountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    RuleStatus string
    Rule status. Options: Enabled, Disabled
    StartRuleEvaluation bool
    Whether to trigger rule re-evaluation. When 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.
    account_group_id string
    Account group ID. Not required for standard rules; required for account group rules
    rule_status string
    Rule status. Options: Enabled, Disabled
    start_rule_evaluation bool
    Whether to trigger rule re-evaluation. When 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 GroupRuleScope
    Resource evaluation scope
    triggers List<GroupRuleTrigger>
    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.
    accountGroupId String
    Account group ID. Not required for standard rules; required for account group rules
    ruleStatus String
    Rule status. Options: Enabled, Disabled
    startRuleEvaluation Boolean
    Whether to trigger rule re-evaluation. When 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 GroupRuleScope
    Resource evaluation scope
    triggers GroupRuleTrigger[]
    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.
    accountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    ruleStatus string
    Rule status. Options: Enabled, Disabled
    startRuleEvaluation boolean
    Whether to trigger rule re-evaluation. When 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 GroupRuleScopeArgs
    Resource evaluation scope
    triggers Sequence[GroupRuleTriggerArgs]
    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.
    account_group_id str
    Account group ID. Not required for standard rules; required for account group rules
    rule_status str
    Rule status. Options: Enabled, Disabled
    start_rule_evaluation bool
    Whether to trigger rule re-evaluation. When 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.
    accountGroupId String
    Account group ID. Not required for standard rules; required for account group rules
    ruleStatus String
    Rule status. Options: Enabled, Disabled
    startRuleEvaluation Boolean
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GroupRule 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 GroupRule Resource

    Get an existing GroupRule 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?: GroupRuleState, opts?: CustomResourceOptions): GroupRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_group_id: Optional[str] = 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[GroupRuleScopeArgs] = None,
        start_rule_evaluation: Optional[bool] = None,
        triggers: Optional[Sequence[GroupRuleTriggerArgs]] = None) -> GroupRule
    func GetGroupRule(ctx *Context, name string, id IDInput, state *GroupRuleState, opts ...ResourceOption) (*GroupRule, error)
    public static GroupRule Get(string name, Input<string> id, GroupRuleState? state, CustomResourceOptions? opts = null)
    public static GroupRule get(String name, Output<String> id, GroupRuleState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:config:GroupRule    get:      id: ${id}
    import {
  to = volcenginecc_config_group_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:
    AccountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    RuleTemplateId string
    Rule template ID
    Scope Volcengine.GroupRuleScope
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update
    Triggers List<Volcengine.GroupRuleTrigger>
    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.
    AccountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    RuleTemplateId string
    Rule template ID
    Scope GroupRuleScopeArgs
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update
    Triggers []GroupRuleTriggerArgs
    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.
    account_group_id string
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    rule_template_id string
    Rule template ID
    scope object
    Resource evaluation scope
    start_rule_evaluation bool
    Whether to trigger rule re-evaluation. When 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.
    accountGroupId String
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    ruleTemplateId String
    Rule template ID
    scope GroupRuleScope
    Resource evaluation scope
    startRuleEvaluation Boolean
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update
    triggers List<GroupRuleTrigger>
    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.
    accountGroupId string
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    ruleTemplateId string
    Rule template ID
    scope GroupRuleScope
    Resource evaluation scope
    startRuleEvaluation boolean
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update
    triggers GroupRuleTrigger[]
    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.
    account_group_id str
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    rule_template_id str
    Rule template ID
    scope GroupRuleScopeArgs
    Resource evaluation scope
    start_rule_evaluation bool
    Whether to trigger rule re-evaluation. When true, StartRuleEvaluation is called during update
    triggers Sequence[GroupRuleTriggerArgs]
    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.
    accountGroupId String
    Account group ID. Not required for standard rules; required for account group rules
    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 status. Options: Enabled, Disabled
    ruleTemplateId String
    Rule template ID
    scope Property Map
    Resource evaluation scope
    startRuleEvaluation Boolean
    Whether to trigger rule re-evaluation. When 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

    GroupRuleScope, GroupRuleScopeArgs

    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 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

    GroupRuleScopeProjects, GroupRuleScopeProjectsArgs

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

    GroupRuleScopeRegions, GroupRuleScopeRegionsArgs

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

    GroupRuleScopeResourceIds, GroupRuleScopeResourceIdsArgs

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

    GroupRuleScopeResourceTypes, GroupRuleScopeResourceTypesArgs

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

    GroupRuleScopeTags, GroupRuleScopeTagsArgs

    Excludes List<Volcengine.GroupRuleScopeTagsExclude>
    Exclude 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.GroupRuleScopeTagsInclude>
    Include 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 []GroupRuleScopeTagsExclude
    Exclude 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 []GroupRuleScopeTagsInclude
    Include 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)
    Exclude 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)
    Include 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<GroupRuleScopeTagsExclude>
    Exclude 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<GroupRuleScopeTagsInclude>
    Include 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 GroupRuleScopeTagsExclude[]
    Exclude 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 GroupRuleScopeTagsInclude[]
    Include 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[GroupRuleScopeTagsExclude]
    Exclude 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[GroupRuleScopeTagsInclude]
    Include 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>
    Exclude 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>
    Include 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.

    GroupRuleScopeTagsExclude, GroupRuleScopeTagsExcludeArgs

    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

    GroupRuleScopeTagsInclude, GroupRuleScopeTagsIncludeArgs

    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

    GroupRuleTrigger, GroupRuleTriggerArgs

    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/groupRule:GroupRule example "account_group_id|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