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

volcenginecc.config.getRule

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

    Data Source schema for Volcengine::Config::Rule

    Using getRule

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

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetRuleResult>
    def get_rule(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(id: pulumi.Input[Optional[str]] = None,
             opts: Optional[InvokeOutputOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

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

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: volcenginecc:config/getRule:getRule
  arguments:
    # arguments dictionary
    data "volcenginecc_config_get_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getRule Result

    The following output properties are available:

    CreatedTime string
    Creation time
    Description string
    Rule description
    Id string
    Uniquely identifies the resource.
    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.GetRuleScope
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    Triggers List<Volcengine.GetRuleTrigger>
    Rule trigger configuration
    CreatedTime string
    Creation time
    Description string
    Rule description
    Id string
    Uniquely identifies the resource.
    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 GetRuleScope
    Resource evaluation scope
    StartRuleEvaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    Triggers []GetRuleTrigger
    Rule trigger configuration
    created_time string
    Creation time
    description string
    Rule description
    id string
    Uniquely identifies the resource.
    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
    createdTime String
    Creation time
    description String
    Rule description
    id String
    Uniquely identifies the resource.
    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 GetRuleScope
    Resource evaluation scope
    startRuleEvaluation Boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers List<GetRuleTrigger>
    Rule trigger configuration
    createdTime string
    Creation time
    description string
    Rule description
    id string
    Uniquely identifies the resource.
    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 GetRuleScope
    Resource evaluation scope
    startRuleEvaluation boolean
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers GetRuleTrigger[]
    Rule trigger configuration
    created_time str
    Creation time
    description str
    Rule description
    id str
    Uniquely identifies the resource.
    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 GetRuleScope
    Resource evaluation scope
    start_rule_evaluation bool
    Whether to trigger regular rule re-evaluation. If true, StartRuleEvaluation is called during update
    triggers Sequence[GetRuleTrigger]
    Rule trigger configuration
    createdTime String
    Creation time
    description String
    Rule description
    id String
    Uniquely identifies the resource.
    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

    Supporting Types

    GetRuleScope

    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

    GetRuleScopeProjects

    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

    GetRuleScopeRegions

    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

    GetRuleScopeResourceIds

    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

    GetRuleScopeResourceTypes

    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

    GetRuleScopeTags

    excludes list(object)
    Exclusion list
    includes list(object)
    Inclusion list

    GetRuleScopeTagsExclude

    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

    GetRuleScopeTagsInclude

    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

    GetRuleTrigger

    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

    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