1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. Alarm
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.tls.Alarm

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage tls alarm

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Tls.Alarm("foo", new()
        {
            AlarmName = "test",
            AlarmNotifyGroups = new[]
            {
                "3019107f-28a2-4208-a2b6-c33fcb97ac3a",
            },
            AlarmPeriodDetail = new Volcengine.Tls.Inputs.AlarmAlarmPeriodDetailArgs
            {
                Email = 2,
                GeneralWebhook = 3,
                Phone = 10,
                Sms = 10,
            },
            Condition = "$1.errNum>0",
            ProjectId = "cc44f8b6-0328-4622-b043-023fca735cd4",
            QueryRequests = new[]
            {
                new Volcengine.Tls.Inputs.AlarmQueryRequestArgs
                {
                    EndTimeOffset = 0,
                    Number = 1,
                    Query = "Failed | select count(*) as errNum",
                    StartTimeOffset = -15,
                    TopicId = "af1a2240-ba62-4f18-b421-bde2f9684e57",
                },
            },
            RequestCycle = new Volcengine.Tls.Inputs.AlarmRequestCycleArgs
            {
                Time = 11,
                Type = "Period",
            },
            UserDefineMsg = "test for terraform",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tls.NewAlarm(ctx, "foo", &tls.AlarmArgs{
    			AlarmName: pulumi.String("test"),
    			AlarmNotifyGroups: pulumi.StringArray{
    				pulumi.String("3019107f-28a2-4208-a2b6-c33fcb97ac3a"),
    			},
    			AlarmPeriodDetail: &tls.AlarmAlarmPeriodDetailArgs{
    				Email:          pulumi.Int(2),
    				GeneralWebhook: pulumi.Int(3),
    				Phone:          pulumi.Int(10),
    				Sms:            pulumi.Int(10),
    			},
    			Condition: pulumi.String("$1.errNum>0"),
    			ProjectId: pulumi.String("cc44f8b6-0328-4622-b043-023fca735cd4"),
    			QueryRequests: tls.AlarmQueryRequestArray{
    				&tls.AlarmQueryRequestArgs{
    					EndTimeOffset:   pulumi.Int(0),
    					Number:          pulumi.Int(1),
    					Query:           pulumi.String("Failed | select count(*) as errNum"),
    					StartTimeOffset: -15,
    					TopicId:         pulumi.String("af1a2240-ba62-4f18-b421-bde2f9684e57"),
    				},
    			},
    			RequestCycle: &tls.AlarmRequestCycleArgs{
    				Time: pulumi.Int(11),
    				Type: pulumi.String("Period"),
    			},
    			UserDefineMsg: pulumi.String("test for terraform"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.tls.Alarm("foo",
        alarm_name="test",
        alarm_notify_groups=["3019107f-28a2-4208-a2b6-c33fcb97ac3a"],
        alarm_period_detail=volcengine.tls.AlarmAlarmPeriodDetailArgs(
            email=2,
            general_webhook=3,
            phone=10,
            sms=10,
        ),
        condition="$1.errNum>0",
        project_id="cc44f8b6-0328-4622-b043-023fca735cd4",
        query_requests=[volcengine.tls.AlarmQueryRequestArgs(
            end_time_offset=0,
            number=1,
            query="Failed | select count(*) as errNum",
            start_time_offset=-15,
            topic_id="af1a2240-ba62-4f18-b421-bde2f9684e57",
        )],
        request_cycle=volcengine.tls.AlarmRequestCycleArgs(
            time=11,
            type="Period",
        ),
        user_define_msg="test for terraform")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.tls.Alarm("foo", {
        alarmName: "test",
        alarmNotifyGroups: ["3019107f-28a2-4208-a2b6-c33fcb97ac3a"],
        alarmPeriodDetail: {
            email: 2,
            generalWebhook: 3,
            phone: 10,
            sms: 10,
        },
        condition: "$1.errNum>0",
        projectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
        queryRequests: [{
            endTimeOffset: 0,
            number: 1,
            query: "Failed | select count(*) as errNum",
            startTimeOffset: -15,
            topicId: "af1a2240-ba62-4f18-b421-bde2f9684e57",
        }],
        requestCycle: {
            time: 11,
            type: "Period",
        },
        userDefineMsg: "test for terraform",
    });
    

    Coming soon!

    Create Alarm Resource

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

    Constructor syntax

    new Alarm(name: string, args: AlarmArgs, opts?: CustomResourceOptions);
    @overload
    def Alarm(resource_name: str,
              args: AlarmArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Alarm(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              alarm_name: Optional[str] = None,
              alarm_notify_groups: Optional[Sequence[str]] = None,
              condition: Optional[str] = None,
              project_id: Optional[str] = None,
              query_requests: Optional[Sequence[AlarmQueryRequestArgs]] = None,
              request_cycle: Optional[AlarmRequestCycleArgs] = None,
              alarm_period: Optional[int] = None,
              alarm_period_detail: Optional[AlarmAlarmPeriodDetailArgs] = None,
              status: Optional[bool] = None,
              trigger_period: Optional[int] = None,
              user_define_msg: Optional[str] = None)
    func NewAlarm(ctx *Context, name string, args AlarmArgs, opts ...ResourceOption) (*Alarm, error)
    public Alarm(string name, AlarmArgs args, CustomResourceOptions? opts = null)
    public Alarm(String name, AlarmArgs args)
    public Alarm(String name, AlarmArgs args, CustomResourceOptions options)
    
    type: volcengine:tls:Alarm
    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 AlarmArgs
    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 AlarmArgs
    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 AlarmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var alarmResource = new Volcengine.Tls.Alarm("alarmResource", new()
    {
        AlarmName = "string",
        AlarmNotifyGroups = new[]
        {
            "string",
        },
        Condition = "string",
        ProjectId = "string",
        QueryRequests = new[]
        {
            new Volcengine.Tls.Inputs.AlarmQueryRequestArgs
            {
                EndTimeOffset = 0,
                Number = 0,
                Query = "string",
                StartTimeOffset = 0,
                TopicId = "string",
            },
        },
        RequestCycle = new Volcengine.Tls.Inputs.AlarmRequestCycleArgs
        {
            Time = 0,
            Type = "string",
        },
        AlarmPeriod = 0,
        AlarmPeriodDetail = new Volcengine.Tls.Inputs.AlarmAlarmPeriodDetailArgs
        {
            Email = 0,
            GeneralWebhook = 0,
            Phone = 0,
            Sms = 0,
        },
        Status = false,
        TriggerPeriod = 0,
        UserDefineMsg = "string",
    });
    
    example, err := tls.NewAlarm(ctx, "alarmResource", &tls.AlarmArgs{
    	AlarmName: pulumi.String("string"),
    	AlarmNotifyGroups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Condition: pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    	QueryRequests: tls.AlarmQueryRequestArray{
    		&tls.AlarmQueryRequestArgs{
    			EndTimeOffset:   pulumi.Int(0),
    			Number:          pulumi.Int(0),
    			Query:           pulumi.String("string"),
    			StartTimeOffset: pulumi.Int(0),
    			TopicId:         pulumi.String("string"),
    		},
    	},
    	RequestCycle: &tls.AlarmRequestCycleArgs{
    		Time: pulumi.Int(0),
    		Type: pulumi.String("string"),
    	},
    	AlarmPeriod: pulumi.Int(0),
    	AlarmPeriodDetail: &tls.AlarmAlarmPeriodDetailArgs{
    		Email:          pulumi.Int(0),
    		GeneralWebhook: pulumi.Int(0),
    		Phone:          pulumi.Int(0),
    		Sms:            pulumi.Int(0),
    	},
    	Status:        pulumi.Bool(false),
    	TriggerPeriod: pulumi.Int(0),
    	UserDefineMsg: pulumi.String("string"),
    })
    
    var alarmResource = new Alarm("alarmResource", AlarmArgs.builder()        
        .alarmName("string")
        .alarmNotifyGroups("string")
        .condition("string")
        .projectId("string")
        .queryRequests(AlarmQueryRequestArgs.builder()
            .endTimeOffset(0)
            .number(0)
            .query("string")
            .startTimeOffset(0)
            .topicId("string")
            .build())
        .requestCycle(AlarmRequestCycleArgs.builder()
            .time(0)
            .type("string")
            .build())
        .alarmPeriod(0)
        .alarmPeriodDetail(AlarmAlarmPeriodDetailArgs.builder()
            .email(0)
            .generalWebhook(0)
            .phone(0)
            .sms(0)
            .build())
        .status(false)
        .triggerPeriod(0)
        .userDefineMsg("string")
        .build());
    
    alarm_resource = volcengine.tls.Alarm("alarmResource",
        alarm_name="string",
        alarm_notify_groups=["string"],
        condition="string",
        project_id="string",
        query_requests=[volcengine.tls.AlarmQueryRequestArgs(
            end_time_offset=0,
            number=0,
            query="string",
            start_time_offset=0,
            topic_id="string",
        )],
        request_cycle=volcengine.tls.AlarmRequestCycleArgs(
            time=0,
            type="string",
        ),
        alarm_period=0,
        alarm_period_detail=volcengine.tls.AlarmAlarmPeriodDetailArgs(
            email=0,
            general_webhook=0,
            phone=0,
            sms=0,
        ),
        status=False,
        trigger_period=0,
        user_define_msg="string")
    
    const alarmResource = new volcengine.tls.Alarm("alarmResource", {
        alarmName: "string",
        alarmNotifyGroups: ["string"],
        condition: "string",
        projectId: "string",
        queryRequests: [{
            endTimeOffset: 0,
            number: 0,
            query: "string",
            startTimeOffset: 0,
            topicId: "string",
        }],
        requestCycle: {
            time: 0,
            type: "string",
        },
        alarmPeriod: 0,
        alarmPeriodDetail: {
            email: 0,
            generalWebhook: 0,
            phone: 0,
            sms: 0,
        },
        status: false,
        triggerPeriod: 0,
        userDefineMsg: "string",
    });
    
    type: volcengine:tls:Alarm
    properties:
        alarmName: string
        alarmNotifyGroups:
            - string
        alarmPeriod: 0
        alarmPeriodDetail:
            email: 0
            generalWebhook: 0
            phone: 0
            sms: 0
        condition: string
        projectId: string
        queryRequests:
            - endTimeOffset: 0
              number: 0
              query: string
              startTimeOffset: 0
              topicId: string
        requestCycle:
            time: 0
            type: string
        status: false
        triggerPeriod: 0
        userDefineMsg: string
    

    Alarm Resource Properties

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

    Inputs

    The Alarm resource accepts the following input properties:

    AlarmName string
    The name of the alarm.
    AlarmNotifyGroups List<string>
    List of notification groups corresponding to the alarm.
    Condition string
    Alarm trigger condition.
    ProjectId string
    The project id.
    QueryRequests List<Volcengine.AlarmQueryRequest>
    Search and analyze sentences, 1~3 can be configured.
    RequestCycle Volcengine.AlarmRequestCycle
    The execution period of the alarm task.
    AlarmPeriod int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    AlarmPeriodDetail Volcengine.AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    Status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    TriggerPeriod int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    UserDefineMsg string
    Customize the alarm notification content.
    AlarmName string
    The name of the alarm.
    AlarmNotifyGroups []string
    List of notification groups corresponding to the alarm.
    Condition string
    Alarm trigger condition.
    ProjectId string
    The project id.
    QueryRequests []AlarmQueryRequestArgs
    Search and analyze sentences, 1~3 can be configured.
    RequestCycle AlarmRequestCycleArgs
    The execution period of the alarm task.
    AlarmPeriod int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    AlarmPeriodDetail AlarmAlarmPeriodDetailArgs
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    Status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    TriggerPeriod int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    UserDefineMsg string
    Customize the alarm notification content.
    alarmName String
    The name of the alarm.
    alarmNotifyGroups List<String>
    List of notification groups corresponding to the alarm.
    condition String
    Alarm trigger condition.
    projectId String
    The project id.
    queryRequests List<AlarmQueryRequest>
    Search and analyze sentences, 1~3 can be configured.
    requestCycle AlarmRequestCycle
    The execution period of the alarm task.
    alarmPeriod Integer
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    status Boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod Integer
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg String
    Customize the alarm notification content.
    alarmName string
    The name of the alarm.
    alarmNotifyGroups string[]
    List of notification groups corresponding to the alarm.
    condition string
    Alarm trigger condition.
    projectId string
    The project id.
    queryRequests AlarmQueryRequest[]
    Search and analyze sentences, 1~3 can be configured.
    requestCycle AlarmRequestCycle
    The execution period of the alarm task.
    alarmPeriod number
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    status boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod number
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg string
    Customize the alarm notification content.
    alarm_name str
    The name of the alarm.
    alarm_notify_groups Sequence[str]
    List of notification groups corresponding to the alarm.
    condition str
    Alarm trigger condition.
    project_id str
    The project id.
    query_requests Sequence[AlarmQueryRequestArgs]
    Search and analyze sentences, 1~3 can be configured.
    request_cycle AlarmRequestCycleArgs
    The execution period of the alarm task.
    alarm_period int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarm_period_detail AlarmAlarmPeriodDetailArgs
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    trigger_period int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    user_define_msg str
    Customize the alarm notification content.
    alarmName String
    The name of the alarm.
    alarmNotifyGroups List<String>
    List of notification groups corresponding to the alarm.
    condition String
    Alarm trigger condition.
    projectId String
    The project id.
    queryRequests List<Property Map>
    Search and analyze sentences, 1~3 can be configured.
    requestCycle Property Map
    The execution period of the alarm task.
    alarmPeriod Number
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail Property Map
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    status Boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod Number
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg String
    Customize the alarm notification content.

    Outputs

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

    AlarmId string
    The alarm id.
    Id string
    The provider-assigned unique ID for this managed resource.
    AlarmId string
    The alarm id.
    Id string
    The provider-assigned unique ID for this managed resource.
    alarmId String
    The alarm id.
    id String
    The provider-assigned unique ID for this managed resource.
    alarmId string
    The alarm id.
    id string
    The provider-assigned unique ID for this managed resource.
    alarm_id str
    The alarm id.
    id str
    The provider-assigned unique ID for this managed resource.
    alarmId String
    The alarm id.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Alarm Resource

    Get an existing Alarm 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?: AlarmState, opts?: CustomResourceOptions): Alarm
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alarm_id: Optional[str] = None,
            alarm_name: Optional[str] = None,
            alarm_notify_groups: Optional[Sequence[str]] = None,
            alarm_period: Optional[int] = None,
            alarm_period_detail: Optional[AlarmAlarmPeriodDetailArgs] = None,
            condition: Optional[str] = None,
            project_id: Optional[str] = None,
            query_requests: Optional[Sequence[AlarmQueryRequestArgs]] = None,
            request_cycle: Optional[AlarmRequestCycleArgs] = None,
            status: Optional[bool] = None,
            trigger_period: Optional[int] = None,
            user_define_msg: Optional[str] = None) -> Alarm
    func GetAlarm(ctx *Context, name string, id IDInput, state *AlarmState, opts ...ResourceOption) (*Alarm, error)
    public static Alarm Get(string name, Input<string> id, AlarmState? state, CustomResourceOptions? opts = null)
    public static Alarm get(String name, Output<String> id, AlarmState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AlarmId string
    The alarm id.
    AlarmName string
    The name of the alarm.
    AlarmNotifyGroups List<string>
    List of notification groups corresponding to the alarm.
    AlarmPeriod int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    AlarmPeriodDetail Volcengine.AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    Condition string
    Alarm trigger condition.
    ProjectId string
    The project id.
    QueryRequests List<Volcengine.AlarmQueryRequest>
    Search and analyze sentences, 1~3 can be configured.
    RequestCycle Volcengine.AlarmRequestCycle
    The execution period of the alarm task.
    Status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    TriggerPeriod int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    UserDefineMsg string
    Customize the alarm notification content.
    AlarmId string
    The alarm id.
    AlarmName string
    The name of the alarm.
    AlarmNotifyGroups []string
    List of notification groups corresponding to the alarm.
    AlarmPeriod int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    AlarmPeriodDetail AlarmAlarmPeriodDetailArgs
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    Condition string
    Alarm trigger condition.
    ProjectId string
    The project id.
    QueryRequests []AlarmQueryRequestArgs
    Search and analyze sentences, 1~3 can be configured.
    RequestCycle AlarmRequestCycleArgs
    The execution period of the alarm task.
    Status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    TriggerPeriod int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    UserDefineMsg string
    Customize the alarm notification content.
    alarmId String
    The alarm id.
    alarmName String
    The name of the alarm.
    alarmNotifyGroups List<String>
    List of notification groups corresponding to the alarm.
    alarmPeriod Integer
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    condition String
    Alarm trigger condition.
    projectId String
    The project id.
    queryRequests List<AlarmQueryRequest>
    Search and analyze sentences, 1~3 can be configured.
    requestCycle AlarmRequestCycle
    The execution period of the alarm task.
    status Boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod Integer
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg String
    Customize the alarm notification content.
    alarmId string
    The alarm id.
    alarmName string
    The name of the alarm.
    alarmNotifyGroups string[]
    List of notification groups corresponding to the alarm.
    alarmPeriod number
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    condition string
    Alarm trigger condition.
    projectId string
    The project id.
    queryRequests AlarmQueryRequest[]
    Search and analyze sentences, 1~3 can be configured.
    requestCycle AlarmRequestCycle
    The execution period of the alarm task.
    status boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod number
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg string
    Customize the alarm notification content.
    alarm_id str
    The alarm id.
    alarm_name str
    The name of the alarm.
    alarm_notify_groups Sequence[str]
    List of notification groups corresponding to the alarm.
    alarm_period int
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarm_period_detail AlarmAlarmPeriodDetailArgs
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    condition str
    Alarm trigger condition.
    project_id str
    The project id.
    query_requests Sequence[AlarmQueryRequestArgs]
    Search and analyze sentences, 1~3 can be configured.
    request_cycle AlarmRequestCycleArgs
    The execution period of the alarm task.
    status bool
    Whether to enable the alert policy. The default value is true, that is, on.
    trigger_period int
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    user_define_msg str
    Customize the alarm notification content.
    alarmId String
    The alarm id.
    alarmName String
    The name of the alarm.
    alarmNotifyGroups List<String>
    List of notification groups corresponding to the alarm.
    alarmPeriod Number
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    alarmPeriodDetail Property Map
    Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
    condition String
    Alarm trigger condition.
    projectId String
    The project id.
    queryRequests List<Property Map>
    Search and analyze sentences, 1~3 can be configured.
    requestCycle Property Map
    The execution period of the alarm task.
    status Boolean
    Whether to enable the alert policy. The default value is true, that is, on.
    triggerPeriod Number
    Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
    userDefineMsg String
    Customize the alarm notification content.

    Supporting Types

    AlarmAlarmPeriodDetail, AlarmAlarmPeriodDetailArgs

    Email int
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    GeneralWebhook int
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    Phone int
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    Sms int
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
    Email int
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    GeneralWebhook int
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    Phone int
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    Sms int
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
    email Integer
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    generalWebhook Integer
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    phone Integer
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    sms Integer
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
    email number
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    generalWebhook number
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    phone number
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    sms number
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
    email int
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    general_webhook int
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    phone int
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    sms int
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
    email Number
    Email alarm period, the unit is minutes, and the value range is 1~1440.
    generalWebhook Number
    Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
    phone Number
    Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
    sms Number
    SMS alarm cycle, the unit is minutes, and the value range is 10~1440.

    AlarmQueryRequest, AlarmQueryRequestArgs

    EndTimeOffset int
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    Number int
    Alarm object sequence number; increments from 1.
    Query string
    Query statement, the maximum supported length is 1024.
    StartTimeOffset int
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    TopicId string
    The id of the topic.
    EndTimeOffset int
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    Number int
    Alarm object sequence number; increments from 1.
    Query string
    Query statement, the maximum supported length is 1024.
    StartTimeOffset int
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    TopicId string
    The id of the topic.
    endTimeOffset Integer
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    number Integer
    Alarm object sequence number; increments from 1.
    query String
    Query statement, the maximum supported length is 1024.
    startTimeOffset Integer
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    topicId String
    The id of the topic.
    endTimeOffset number
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    number number
    Alarm object sequence number; increments from 1.
    query string
    Query statement, the maximum supported length is 1024.
    startTimeOffset number
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    topicId string
    The id of the topic.
    end_time_offset int
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    number int
    Alarm object sequence number; increments from 1.
    query str
    Query statement, the maximum supported length is 1024.
    start_time_offset int
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    topic_id str
    The id of the topic.
    endTimeOffset Number
    The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
    number Number
    Alarm object sequence number; increments from 1.
    query String
    Query statement, the maximum supported length is 1024.
    startTimeOffset Number
    The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
    topicId String
    The id of the topic.

    AlarmRequestCycle, AlarmRequestCycleArgs

    Time int
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    Type string
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.
    Time int
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    Type string
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.
    time Integer
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    type String
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.
    time number
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    type string
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.
    time int
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    type str
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.
    time Number
    The cycle of alarm task execution, or the time point of periodic execution. The unit is minutes, and the value range is 1~1440.
    type String
    Execution cycle type. Period: Periodic execution, which means executing once every certain period of time. Fixed: Regular execution, which means executing at a fixed time point every day.

    Import

    tls alarm can be imported using the id and project id, e.g.

     $ pulumi import volcengine:tls/alarm:Alarm default projectId:fc************
    

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

    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.23 published on Wednesday, Jan 3, 2024 by Volcengine