volcenginecc.vmp.AlertingRule

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  vMPAlertingRuleDemo:
    type: volcenginecc:vmp:AlertingRule
    name: VMPAlertingRuleDemo
    properties:
      name: alert-rule-demo
      description: this is a alert rule demo
      type: vmp/PromQL
      query:
        prom_ql: http_requests_total{method="PUT", status="404"}
        workspace_id: e9e4b146-0ba9-41ac-af2b-xxxxxx
      levels:
        - level: P0
          for: 1s
          comparator: <
          threshold: 5
        - level: P1
          for: 6m
          comparator: <=
          threshold: 10
        - level: P2
          for: 10m
          comparator: '!='
          threshold: 20
      notifyPolicyId: 2890eb5e-f383-4a7b-810f-xxxxxxx
      notifyGroupPolicyId: a8490e9b-4e5d-4a86-xxxx-xxxxxxx
      annotations:
        - name: Key
          value: Value
      labels:
        - name: LabelsKey
          value: LabelsValue
      status: Running
      tags:
        - key: env
          value: test

Create AlertingRule Resource

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

Constructor syntax

new AlertingRule(name: string, args: AlertingRuleArgs, opts?: CustomResourceOptions);

@overload
def AlertingRule(resource_name: str,
                 args: AlertingRuleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def AlertingRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 name: Optional[str] = None,
                 type: Optional[str] = None,
                 annotations: Optional[Sequence[AlertingRuleAnnotationArgs]] = None,
                 description: Optional[str] = None,
                 labels: Optional[Sequence[AlertingRuleLabelArgs]] = None,
                 levels: Optional[Sequence[AlertingRuleLevelArgs]] = None,
                 notify_group_policy_id: Optional[str] = None,
                 notify_policy_id: Optional[str] = None,
                 query: Optional[AlertingRuleQueryArgs] = None,
                 status: Optional[str] = None,
                 tags: Optional[Sequence[AlertingRuleTagArgs]] = None)

func NewAlertingRule(ctx *Context, name string, args AlertingRuleArgs, opts ...ResourceOption) (*AlertingRule, error)

public AlertingRule(string name, AlertingRuleArgs args, CustomResourceOptions? opts = null)

public AlertingRule(String name, AlertingRuleArgs args)
public AlertingRule(String name, AlertingRuleArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args AlertingRuleArgs: 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 AlertingRuleArgs: 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 AlertingRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlertingRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AlertingRuleArgs: 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 alertingRuleResource = new Volcenginecc.Vmp.AlertingRule("alertingRuleResource", new()
{
    Name = "string",
    Type = "string",
    Annotations = new[]
    {
        new Volcenginecc.Vmp.Inputs.AlertingRuleAnnotationArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Description = "string",
    Labels = new[]
    {
        new Volcenginecc.Vmp.Inputs.AlertingRuleLabelArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Levels = new[]
    {
        new Volcenginecc.Vmp.Inputs.AlertingRuleLevelArgs
        {
            Comparator = "string",
            For = "string",
            Level = "string",
            Threshold = 0,
        },
    },
    NotifyGroupPolicyId = "string",
    NotifyPolicyId = "string",
    Query = new Volcenginecc.Vmp.Inputs.AlertingRuleQueryArgs
    {
        PromQl = "string",
        WorkspaceId = "string",
    },
    Status = "string",
    Tags = new[]
    {
        new Volcenginecc.Vmp.Inputs.AlertingRuleTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

example, err := vmp.NewAlertingRule(ctx, "alertingRuleResource", &vmp.AlertingRuleArgs{
	Name: pulumi.String("string"),
	Type: pulumi.String("string"),
	Annotations: vmp.AlertingRuleAnnotationArray{
		&vmp.AlertingRuleAnnotationArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Labels: vmp.AlertingRuleLabelArray{
		&vmp.AlertingRuleLabelArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Levels: vmp.AlertingRuleLevelArray{
		&vmp.AlertingRuleLevelArgs{
			Comparator: pulumi.String("string"),
			For:        pulumi.String("string"),
			Level:      pulumi.String("string"),
			Threshold:  pulumi.Float64(0),
		},
	},
	NotifyGroupPolicyId: pulumi.String("string"),
	NotifyPolicyId:      pulumi.String("string"),
	Query: &vmp.AlertingRuleQueryArgs{
		PromQl:      pulumi.String("string"),
		WorkspaceId: pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Tags: vmp.AlertingRuleTagArray{
		&vmp.AlertingRuleTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

var alertingRuleResource = new AlertingRule("alertingRuleResource", AlertingRuleArgs.builder()
    .name("string")
    .type("string")
    .annotations(AlertingRuleAnnotationArgs.builder()
        .name("string")
        .value("string")
        .build())
    .description("string")
    .labels(AlertingRuleLabelArgs.builder()
        .name("string")
        .value("string")
        .build())
    .levels(AlertingRuleLevelArgs.builder()
        .comparator("string")
        .for_("string")
        .level("string")
        .threshold(0.0)
        .build())
    .notifyGroupPolicyId("string")
    .notifyPolicyId("string")
    .query(AlertingRuleQueryArgs.builder()
        .promQl("string")
        .workspaceId("string")
        .build())
    .status("string")
    .tags(AlertingRuleTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

alerting_rule_resource = volcenginecc.vmp.AlertingRule("alertingRuleResource",
    name="string",
    type="string",
    annotations=[{
        "name": "string",
        "value": "string",
    }],
    description="string",
    labels=[{
        "name": "string",
        "value": "string",
    }],
    levels=[{
        "comparator": "string",
        "for_": "string",
        "level": "string",
        "threshold": float(0),
    }],
    notify_group_policy_id="string",
    notify_policy_id="string",
    query={
        "prom_ql": "string",
        "workspace_id": "string",
    },
    status="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

const alertingRuleResource = new volcenginecc.vmp.AlertingRule("alertingRuleResource", {
    name: "string",
    type: "string",
    annotations: [{
        name: "string",
        value: "string",
    }],
    description: "string",
    labels: [{
        name: "string",
        value: "string",
    }],
    levels: [{
        comparator: "string",
        "for": "string",
        level: "string",
        threshold: 0,
    }],
    notifyGroupPolicyId: "string",
    notifyPolicyId: "string",
    query: {
        promQl: "string",
        workspaceId: "string",
    },
    status: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

type: volcenginecc:vmp:AlertingRule
properties:
    annotations:
        - name: string
          value: string
    description: string
    labels:
        - name: string
          value: string
    levels:
        - comparator: string
          for: string
          level: string
          threshold: 0
    name: string
    notifyGroupPolicyId: string
    notifyPolicyId: string
    query:
        promQl: string
        workspaceId: string
    status: string
    tags:
        - key: string
          value: string
    type: string

AlertingRule 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 AlertingRule resource accepts the following input properties:

Name string: Alert rule name
Type string: Alert rule type. Allowed values: vmp/PromQL
Annotations List<Volcengine.AlertingRuleAnnotation>
Description string: Alert rule description
Labels List<Volcengine.AlertingRuleLabel>
Levels List<Volcengine.AlertingRuleLevel>
NotifyGroupPolicyId string: Alert aggregation policy ID
NotifyPolicyId string: Alert notification policy ID
Query Volcengine.AlertingRuleQuery: Alert configuration
Status string: Alert rule status: Running (monitoring), Disabled (disabled)
Tags List<Volcengine.AlertingRuleTag>

Name string: Alert rule name
Type string: Alert rule type. Allowed values: vmp/PromQL
Annotations []AlertingRuleAnnotationArgs
Description string: Alert rule description
Labels []AlertingRuleLabelArgs
Levels []AlertingRuleLevelArgs
NotifyGroupPolicyId string: Alert aggregation policy ID
NotifyPolicyId string: Alert notification policy ID
Query AlertingRuleQueryArgs: Alert configuration
Status string: Alert rule status: Running (monitoring), Disabled (disabled)
Tags []AlertingRuleTagArgs

name String: Alert rule name
type String: Alert rule type. Allowed values: vmp/PromQL
annotations List<AlertingRuleAnnotation>
description String: Alert rule description
labels List<AlertingRuleLabel>
levels List<AlertingRuleLevel>
notifyGroupPolicyId String: Alert aggregation policy ID
notifyPolicyId String: Alert notification policy ID
query AlertingRuleQuery: Alert configuration
status String: Alert rule status: Running (monitoring), Disabled (disabled)
tags List<AlertingRuleTag>

name string: Alert rule name
type string: Alert rule type. Allowed values: vmp/PromQL
annotations AlertingRuleAnnotation[]
description string: Alert rule description
labels AlertingRuleLabel[]
levels AlertingRuleLevel[]
notifyGroupPolicyId string: Alert aggregation policy ID
notifyPolicyId string: Alert notification policy ID
query AlertingRuleQuery: Alert configuration
status string: Alert rule status: Running (monitoring), Disabled (disabled)
tags AlertingRuleTag[]

name str: Alert rule name
type str: Alert rule type. Allowed values: vmp/PromQL
annotations Sequence[AlertingRuleAnnotationArgs]
description str: Alert rule description
labels Sequence[AlertingRuleLabelArgs]
levels Sequence[AlertingRuleLevelArgs]
notify_group_policy_id str: Alert aggregation policy ID
notify_policy_id str: Alert notification policy ID
query AlertingRuleQueryArgs: Alert configuration
status str: Alert rule status: Running (monitoring), Disabled (disabled)
tags Sequence[AlertingRuleTagArgs]

name String: Alert rule name
type String: Alert rule type. Allowed values: vmp/PromQL
annotations List<Property Map>
description String: Alert rule description
labels List<Property Map>
levels List<Property Map>
notifyGroupPolicyId String: Alert aggregation policy ID
notifyPolicyId String: Alert notification policy ID
query Property Map: Alert configuration
status String: Alert rule status: Running (monitoring), Disabled (disabled)
tags List<Property Map>

Outputs

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

AlertingRuleId string: Alert rule ID
CreateTime string: Alert rule creation time
Id string: The provider-assigned unique ID for this managed resource.
UpdateTime string: Alert rule update time

AlertingRuleId string: Alert rule ID
CreateTime string: Alert rule creation time
Id string: The provider-assigned unique ID for this managed resource.
UpdateTime string: Alert rule update time

alertingRuleId String: Alert rule ID
createTime String: Alert rule creation time
id String: The provider-assigned unique ID for this managed resource.
updateTime String: Alert rule update time

alertingRuleId string: Alert rule ID
createTime string: Alert rule creation time
id string: The provider-assigned unique ID for this managed resource.
updateTime string: Alert rule update time

alerting_rule_id str: Alert rule ID
create_time str: Alert rule creation time
id str: The provider-assigned unique ID for this managed resource.
update_time str: Alert rule update time

alertingRuleId String: Alert rule ID
createTime String: Alert rule creation time
id String: The provider-assigned unique ID for this managed resource.
updateTime String: Alert rule update time

Look up Existing AlertingRule Resource

Get an existing AlertingRule 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?: AlertingRuleState, opts?: CustomResourceOptions): AlertingRule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alerting_rule_id: Optional[str] = None,
        annotations: Optional[Sequence[AlertingRuleAnnotationArgs]] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Sequence[AlertingRuleLabelArgs]] = None,
        levels: Optional[Sequence[AlertingRuleLevelArgs]] = None,
        name: Optional[str] = None,
        notify_group_policy_id: Optional[str] = None,
        notify_policy_id: Optional[str] = None,
        query: Optional[AlertingRuleQueryArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[AlertingRuleTagArgs]] = None,
        type: Optional[str] = None,
        update_time: Optional[str] = None) -> AlertingRule

func GetAlertingRule(ctx *Context, name string, id IDInput, state *AlertingRuleState, opts ...ResourceOption) (*AlertingRule, error)

public static AlertingRule Get(string name, Input<string> id, AlertingRuleState? state, CustomResourceOptions? opts = null)

public static AlertingRule get(String name, Output<String> id, AlertingRuleState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:vmp:AlertingRule    get:      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:

AlertingRuleId string: Alert rule ID
Annotations List<Volcengine.AlertingRuleAnnotation>
CreateTime string: Alert rule creation time
Description string: Alert rule description
Labels List<Volcengine.AlertingRuleLabel>
Levels List<Volcengine.AlertingRuleLevel>
Name string: Alert rule name
NotifyGroupPolicyId string: Alert aggregation policy ID
NotifyPolicyId string: Alert notification policy ID
Query Volcengine.AlertingRuleQuery: Alert configuration
Status string: Alert rule status: Running (monitoring), Disabled (disabled)
Tags List<Volcengine.AlertingRuleTag>
Type string: Alert rule type. Allowed values: vmp/PromQL
UpdateTime string: Alert rule update time

AlertingRuleId string: Alert rule ID
Annotations []AlertingRuleAnnotationArgs
CreateTime string: Alert rule creation time
Description string: Alert rule description
Labels []AlertingRuleLabelArgs
Levels []AlertingRuleLevelArgs
Name string: Alert rule name
NotifyGroupPolicyId string: Alert aggregation policy ID
NotifyPolicyId string: Alert notification policy ID
Query AlertingRuleQueryArgs: Alert configuration
Status string: Alert rule status: Running (monitoring), Disabled (disabled)
Tags []AlertingRuleTagArgs
Type string: Alert rule type. Allowed values: vmp/PromQL
UpdateTime string: Alert rule update time

alertingRuleId String: Alert rule ID
annotations List<AlertingRuleAnnotation>
createTime String: Alert rule creation time
description String: Alert rule description
labels List<AlertingRuleLabel>
levels List<AlertingRuleLevel>
name String: Alert rule name
notifyGroupPolicyId String: Alert aggregation policy ID
notifyPolicyId String: Alert notification policy ID
query AlertingRuleQuery: Alert configuration
status String: Alert rule status: Running (monitoring), Disabled (disabled)
tags List<AlertingRuleTag>
type String: Alert rule type. Allowed values: vmp/PromQL
updateTime String: Alert rule update time

alertingRuleId string: Alert rule ID
annotations AlertingRuleAnnotation[]
createTime string: Alert rule creation time
description string: Alert rule description
labels AlertingRuleLabel[]
levels AlertingRuleLevel[]
name string: Alert rule name
notifyGroupPolicyId string: Alert aggregation policy ID
notifyPolicyId string: Alert notification policy ID
query AlertingRuleQuery: Alert configuration
status string: Alert rule status: Running (monitoring), Disabled (disabled)
tags AlertingRuleTag[]
type string: Alert rule type. Allowed values: vmp/PromQL
updateTime string: Alert rule update time

alerting_rule_id str: Alert rule ID
annotations Sequence[AlertingRuleAnnotationArgs]
create_time str: Alert rule creation time
description str: Alert rule description
labels Sequence[AlertingRuleLabelArgs]
levels Sequence[AlertingRuleLevelArgs]
name str: Alert rule name
notify_group_policy_id str: Alert aggregation policy ID
notify_policy_id str: Alert notification policy ID
query AlertingRuleQueryArgs: Alert configuration
status str: Alert rule status: Running (monitoring), Disabled (disabled)
tags Sequence[AlertingRuleTagArgs]
type str: Alert rule type. Allowed values: vmp/PromQL
update_time str: Alert rule update time

alertingRuleId String: Alert rule ID
annotations List<Property Map>
createTime String: Alert rule creation time
description String: Alert rule description
labels List<Property Map>
levels List<Property Map>
name String: Alert rule name
notifyGroupPolicyId String: Alert aggregation policy ID
notifyPolicyId String: Alert notification policy ID
query Property Map: Alert configuration
status String: Alert rule status: Running (monitoring), Disabled (disabled)
tags List<Property Map>
type String: Alert rule type. Allowed values: vmp/PromQL
updateTime String: Alert rule update time

Supporting Types

AlertingRuleAnnotation, AlertingRuleAnnotationArgs

Name string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

Name string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

name String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

name string: Tag or annotation key
value string: Tag or annotation value. If set to empty, the key will be deleted

name str: Tag or annotation key
value str: Tag or annotation value. If set to empty, the key will be deleted

name String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

AlertingRuleLabel, AlertingRuleLabelArgs

Name string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

Name string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

name String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

name string: Tag or annotation key
value string: Tag or annotation value. If set to empty, the key will be deleted

name str: Tag or annotation key
value str: Tag or annotation value. If set to empty, the key will be deleted

name String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

AlertingRuleLevel, AlertingRuleLevelArgs

Comparator string: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
For string: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
Level string: Alert rule severity. Currently supports P0, P1, or P2
Threshold double: Alert rule threshold

Comparator string: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
For string: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
Level string: Alert rule severity. Currently supports P0, P1, or P2
Threshold float64: Alert rule threshold

comparator String: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
for_ String: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
level String: Alert rule severity. Currently supports P0, P1, or P2
threshold Double: Alert rule threshold

comparator string: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
for string: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
level string: Alert rule severity. Currently supports P0, P1, or P2
threshold number: Alert rule threshold

comparator str: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
for_ str: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
level str: Alert rule severity. Currently supports P0, P1, or P2
threshold float: Alert rule threshold

comparator String: Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
for String: Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
level String: Alert rule severity. Currently supports P0, P1, or P2
threshold Number: Alert rule threshold

AlertingRuleQuery, AlertingRuleQueryArgs

PromQl string: Query statement
WorkspaceId string: Workspace ID

PromQl string: Query statement
WorkspaceId string: Workspace ID

promQl String: Query statement
workspaceId String: Workspace ID

promQl string: Query statement
workspaceId string: Workspace ID

prom_ql str: Query statement
workspace_id str: Workspace ID

promQl String: Query statement
workspaceId String: Workspace ID

AlertingRuleTag, AlertingRuleTagArgs

Key string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

Key string: Tag or annotation key
Value string: Tag or annotation value. If set to empty, the key will be deleted

key String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

key string: Tag or annotation key
value string: Tag or annotation value. If set to empty, the key will be deleted

key str: Tag or annotation key
value str: Tag or annotation value. If set to empty, the key will be deleted

key String: Tag or annotation key
value String: Tag or annotation value. If set to empty, the key will be deleted

Import

$ pulumi import volcenginecc:vmp/alertingRule:AlertingRule example "alerting_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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.vmp.AlertingRule

On this page

On this page

Example Usage

Create AlertingRule Resource

Constructor syntax

Parameters

Constructor example

AlertingRule Resource Properties

Inputs

Outputs

Look up Existing AlertingRule Resource

Supporting Types

AlertingRuleAnnotation, AlertingRuleAnnotationArgs

AlertingRuleLabel, AlertingRuleLabelArgs

AlertingRuleLevel, AlertingRuleLevelArgs

AlertingRuleQuery, AlertingRuleQueryArgs

AlertingRuleTag, AlertingRuleTagArgs

Import

Package Details

On this page

On this page