Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. cloud_monitor
  5. getEventRules
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.cloud_monitor.getEventRules

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of cloud monitor event rules

    Example Usage

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

const foo = volcengine.cloud_monitor.getEventRules({
    ruleName: "tftest",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloud_monitor.get_event_rules(rule_name="tftest")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloud_monitor.GetEventRules(ctx, &cloud_monitor.GetEventRulesArgs{
			RuleName: pulumi.StringRef("tftest"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Cloud_monitor.GetEventRules.Invoke(new()
    {
        RuleName = "tftest",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_monitor.Cloud_monitorFunctions;
import com.pulumi.volcengine.cloud_monitor.inputs.GetEventRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var foo = Cloud_monitorFunctions.getEventRules(GetEventRulesArgs.builder()
            .ruleName("tftest")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:cloud_monitor:getEventRules
      Arguments:
        ruleName: tftest

    Using getEventRules

    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 getEventRules(args: GetEventRulesArgs, opts?: InvokeOptions): Promise<GetEventRulesResult>
function getEventRulesOutput(args: GetEventRulesOutputArgs, opts?: InvokeOptions): Output<GetEventRulesResult>
    def get_event_rules(output_file: Optional[str] = None,
                    rule_name: Optional[str] = None,
                    source: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEventRulesResult
def get_event_rules_output(output_file: Optional[pulumi.Input[str]] = None,
                    rule_name: Optional[pulumi.Input[str]] = None,
                    source: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEventRulesResult]
    func GetEventRules(ctx *Context, args *GetEventRulesArgs, opts ...InvokeOption) (*GetEventRulesResult, error)
func GetEventRulesOutput(ctx *Context, args *GetEventRulesOutputArgs, opts ...InvokeOption) GetEventRulesResultOutput

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

    public static class GetEventRules 
{
    public static Task<GetEventRulesResult> InvokeAsync(GetEventRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetEventRulesResult> Invoke(GetEventRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEventRulesResult> getEventRules(GetEventRulesArgs args, InvokeOptions options)
public static Output<GetEventRulesResult> getEventRules(GetEventRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:cloud_monitor/getEventRules:getEventRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OutputFile string
    File name where to save data source results.
    RuleName string
    Rule name, search rules by name using fuzzy search.
    Source string
    Event source.
    OutputFile string
    File name where to save data source results.
    RuleName string
    Rule name, search rules by name using fuzzy search.
    Source string
    Event source.
    outputFile String
    File name where to save data source results.
    ruleName String
    Rule name, search rules by name using fuzzy search.
    source String
    Event source.
    outputFile string
    File name where to save data source results.
    ruleName string
    Rule name, search rules by name using fuzzy search.
    source string
    Event source.
    output_file str
    File name where to save data source results.
    rule_name str
    Rule name, search rules by name using fuzzy search.
    source str
    Event source.
    outputFile String
    File name where to save data source results.
    ruleName String
    Rule name, search rules by name using fuzzy search.
    source String
    Event source.

    getEventRules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Rules List<GetEventRulesRule>
    The collection of query.
    TotalCount int
    The total count of query.
    OutputFile string
    RuleName string
    The name of the rule.
    Source string
    Event source corresponding to pattern matching.
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules []GetEventRulesRule
    The collection of query.
    TotalCount int
    The total count of query.
    OutputFile string
    RuleName string
    The name of the rule.
    Source string
    Event source corresponding to pattern matching.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<GetEventRulesRule>
    The collection of query.
    totalCount Integer
    The total count of query.
    outputFile String
    ruleName String
    The name of the rule.
    source String
    Event source corresponding to pattern matching.
    id string
    The provider-assigned unique ID for this managed resource.
    rules GetEventRulesRule[]
    The collection of query.
    totalCount number
    The total count of query.
    outputFile string
    ruleName string
    The name of the rule.
    source string
    Event source corresponding to pattern matching.
    id str
    The provider-assigned unique ID for this managed resource.
    rules Sequence[GetEventRulesRule]
    The collection of query.
    total_count int
    The total count of query.
    output_file str
    rule_name str
    The name of the rule.
    source str
    Event source corresponding to pattern matching.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    outputFile String
    ruleName String
    The name of the rule.
    source String
    Event source corresponding to pattern matching.

    Supporting Types

    GetEventRulesRule

    AccountId string
    The id of the account.
    ContactGroupIds List<string>
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    ContactMethods List<string>
    List of contact methods.
    CreatedAt int
    The create time.
    Description string
    The description of the rule.
    EffectEndAt string
    The end time of the rule.
    EffectStartAt string
    The start time of the rule.
    Endpoint string
    When the alarm notification method is alarm callback, it triggers the callback address.
    EventBusName string
    The name of the event bus.
    EventSource string
    The source of the event.
    EventTypes List<string>
    The event type.
    FilterPatterns List<GetEventRulesRuleFilterPattern>
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    Id string
    The id of the rule.
    Level string
    The level of the rule.
    MessageQueues List<GetEventRulesRuleMessageQueue>
    The triggered message queue when the alarm notification method is Kafka message queue.
    Region string
    The name of the region.
    RuleId string
    The id of the rule.
    RuleName string
    Rule name, search rules by name using fuzzy search.
    Status string
    Enable the state of the rule.
    TlsTargets List<GetEventRulesRuleTlsTarget>
    The alarm method for log service triggers the configuration of the log service.
    UpdatedAt int
    The updated time.
    AccountId string
    The id of the account.
    ContactGroupIds []string
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    ContactMethods []string
    List of contact methods.
    CreatedAt int
    The create time.
    Description string
    The description of the rule.
    EffectEndAt string
    The end time of the rule.
    EffectStartAt string
    The start time of the rule.
    Endpoint string
    When the alarm notification method is alarm callback, it triggers the callback address.
    EventBusName string
    The name of the event bus.
    EventSource string
    The source of the event.
    EventTypes []string
    The event type.
    FilterPatterns []GetEventRulesRuleFilterPattern
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    Id string
    The id of the rule.
    Level string
    The level of the rule.
    MessageQueues []GetEventRulesRuleMessageQueue
    The triggered message queue when the alarm notification method is Kafka message queue.
    Region string
    The name of the region.
    RuleId string
    The id of the rule.
    RuleName string
    Rule name, search rules by name using fuzzy search.
    Status string
    Enable the state of the rule.
    TlsTargets []GetEventRulesRuleTlsTarget
    The alarm method for log service triggers the configuration of the log service.
    UpdatedAt int
    The updated time.
    accountId String
    The id of the account.
    contactGroupIds List<String>
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    contactMethods List<String>
    List of contact methods.
    createdAt Integer
    The create time.
    description String
    The description of the rule.
    effectEndAt String
    The end time of the rule.
    effectStartAt String
    The start time of the rule.
    endpoint String
    When the alarm notification method is alarm callback, it triggers the callback address.
    eventBusName String
    The name of the event bus.
    eventSource String
    The source of the event.
    eventTypes List<String>
    The event type.
    filterPatterns List<GetEventRulesRuleFilterPattern>
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    id String
    The id of the rule.
    level String
    The level of the rule.
    messageQueues List<GetEventRulesRuleMessageQueue>
    The triggered message queue when the alarm notification method is Kafka message queue.
    region String
    The name of the region.
    ruleId String
    The id of the rule.
    ruleName String
    Rule name, search rules by name using fuzzy search.
    status String
    Enable the state of the rule.
    tlsTargets List<GetEventRulesRuleTlsTarget>
    The alarm method for log service triggers the configuration of the log service.
    updatedAt Integer
    The updated time.
    accountId string
    The id of the account.
    contactGroupIds string[]
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    contactMethods string[]
    List of contact methods.
    createdAt number
    The create time.
    description string
    The description of the rule.
    effectEndAt string
    The end time of the rule.
    effectStartAt string
    The start time of the rule.
    endpoint string
    When the alarm notification method is alarm callback, it triggers the callback address.
    eventBusName string
    The name of the event bus.
    eventSource string
    The source of the event.
    eventTypes string[]
    The event type.
    filterPatterns GetEventRulesRuleFilterPattern[]
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    id string
    The id of the rule.
    level string
    The level of the rule.
    messageQueues GetEventRulesRuleMessageQueue[]
    The triggered message queue when the alarm notification method is Kafka message queue.
    region string
    The name of the region.
    ruleId string
    The id of the rule.
    ruleName string
    Rule name, search rules by name using fuzzy search.
    status string
    Enable the state of the rule.
    tlsTargets GetEventRulesRuleTlsTarget[]
    The alarm method for log service triggers the configuration of the log service.
    updatedAt number
    The updated time.
    account_id str
    The id of the account.
    contact_group_ids Sequence[str]
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    contact_methods Sequence[str]
    List of contact methods.
    created_at int
    The create time.
    description str
    The description of the rule.
    effect_end_at str
    The end time of the rule.
    effect_start_at str
    The start time of the rule.
    endpoint str
    When the alarm notification method is alarm callback, it triggers the callback address.
    event_bus_name str
    The name of the event bus.
    event_source str
    The source of the event.
    event_types Sequence[str]
    The event type.
    filter_patterns Sequence[GetEventRulesRuleFilterPattern]
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    id str
    The id of the rule.
    level str
    The level of the rule.
    message_queues Sequence[GetEventRulesRuleMessageQueue]
    The triggered message queue when the alarm notification method is Kafka message queue.
    region str
    The name of the region.
    rule_id str
    The id of the rule.
    rule_name str
    Rule name, search rules by name using fuzzy search.
    status str
    Enable the state of the rule.
    tls_targets Sequence[GetEventRulesRuleTlsTarget]
    The alarm method for log service triggers the configuration of the log service.
    updated_at int
    The updated time.
    accountId String
    The id of the account.
    contactGroupIds List<String>
    When the alarm notification method is phone, SMS, or email, the triggered alarm contact group ID.
    contactMethods List<String>
    List of contact methods.
    createdAt Number
    The create time.
    description String
    The description of the rule.
    effectEndAt String
    The end time of the rule.
    effectStartAt String
    The start time of the rule.
    endpoint String
    When the alarm notification method is alarm callback, it triggers the callback address.
    eventBusName String
    The name of the event bus.
    eventSource String
    The source of the event.
    eventTypes List<String>
    The event type.
    filterPatterns List<Property Map>
    Filter mode, also known as event matching rules. Custom matching rules are not currently supported.
    id String
    The id of the rule.
    level String
    The level of the rule.
    messageQueues List<Property Map>
    The triggered message queue when the alarm notification method is Kafka message queue.
    region String
    The name of the region.
    ruleId String
    The id of the rule.
    ruleName String
    Rule name, search rules by name using fuzzy search.
    status String
    Enable the state of the rule.
    tlsTargets List<Property Map>
    The alarm method for log service triggers the configuration of the log service.
    updatedAt Number
    The updated time.

    GetEventRulesRuleFilterPattern

    Source string
    Event source.
    Types List<string>
    The message queue type, only support kafka now.
    Source string
    Event source.
    Types []string
    The message queue type, only support kafka now.
    source String
    Event source.
    types List<String>
    The message queue type, only support kafka now.
    source string
    Event source.
    types string[]
    The message queue type, only support kafka now.
    source str
    Event source.
    types Sequence[str]
    The message queue type, only support kafka now.
    source String
    Event source.
    types List<String>
    The message queue type, only support kafka now.

    GetEventRulesRuleMessageQueue

    InstanceId string
    The kafka instance id.
    Region string
    The name of the region.
    Topic string
    The topic name.
    Type string
    The message queue type, only support kafka now.
    VpcId string
    The vpc id.
    InstanceId string
    The kafka instance id.
    Region string
    The name of the region.
    Topic string
    The topic name.
    Type string
    The message queue type, only support kafka now.
    VpcId string
    The vpc id.
    instanceId String
    The kafka instance id.
    region String
    The name of the region.
    topic String
    The topic name.
    type String
    The message queue type, only support kafka now.
    vpcId String
    The vpc id.
    instanceId string
    The kafka instance id.
    region string
    The name of the region.
    topic string
    The topic name.
    type string
    The message queue type, only support kafka now.
    vpcId string
    The vpc id.
    instance_id str
    The kafka instance id.
    region str
    The name of the region.
    topic str
    The topic name.
    type str
    The message queue type, only support kafka now.
    vpc_id str
    The vpc id.
    instanceId String
    The kafka instance id.
    region String
    The name of the region.
    topic String
    The topic name.
    type String
    The message queue type, only support kafka now.
    vpcId String
    The vpc id.

    GetEventRulesRuleTlsTarget

    ProjectId string
    The project id.
    ProjectName string
    The project name.
    RegionNameCn string
    The Chinese region name.
    RegionNameEn string
    The English region name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    ProjectId string
    The project id.
    ProjectName string
    The project name.
    RegionNameCn string
    The Chinese region name.
    RegionNameEn string
    The English region name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    projectId String
    The project id.
    projectName String
    The project name.
    regionNameCn String
    The Chinese region name.
    regionNameEn String
    The English region name.
    topicId String
    The topic id.
    topicName String
    The topic name.
    projectId string
    The project id.
    projectName string
    The project name.
    regionNameCn string
    The Chinese region name.
    regionNameEn string
    The English region name.
    topicId string
    The topic id.
    topicName string
    The topic name.
    project_id str
    The project id.
    project_name str
    The project name.
    region_name_cn str
    The Chinese region name.
    region_name_en str
    The English region name.
    topic_id str
    The topic id.
    topic_name str
    The topic name.
    projectId String
    The project id.
    projectName String
    The project name.
    regionNameCn String
    The Chinese region name.
    regionNameEn String
    The English region name.
    topicId String
    The topic id.
    topicName String
    The topic name.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine