1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. tls
  6. Alarm
Viewing docs for bytepluscc v0.0.30
published on Monday, May 25, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.30
published on Monday, May 25, 2026 by Byteplus

    Alert policy. The logging service periodically analyzes data and sends alerts that meet the trigger conditions to the specified notification objects

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      tLSAlarmDemo:
        type: bytepluscc:tls:Alarm
        name: TLSAlarmDemo
        properties:
          alarmName: ccapi-test
          projectId: project_id_xxxx
          status: false
          queryRequests:
            - end_time_offset: -1
              end_time_offset_unit: ""
              query: raw:"error" | SELECT __time__, hostname, raw ORDER BY __time__ DESC LIMIT 5
              start_time_offset: -11
              start_time_offset_unit: ""
              time_span_type: ""
              topic_id: topic_id_xxxx
              topic_name: topic_name_xxxx
              truncated_time: ""
            - end_time_offset: -5
              end_time_offset_unit: ""
              query: test
              start_time_offset: -15
              start_time_offset_unit: ""
              time_span_type: ""
              topic_id: topic_id_xxxx
              topic_name: topic_name_xxxx
              truncated_time: ""
            - end_time_offset: -60
              end_time_offset_unit: ""
              query: demo
              start_time_offset: -120
              start_time_offset_unit: ""
              time_span_type: ""
              topic_id: topic_id_xxxx
              topic_name: topic_name_xxxx
              truncated_time: ""
          requestCycle:
            cron_tab: 0 0/1 * * *
            time: 0
            type: CronTab
            cron_time_zone: Asia/Shanghai
          triggerPeriod: 10
          alarmPeriod: 1440
          alarmPeriodDetail:
            email: 1440
            phone: 1440
            sms: 1440
            general_webhook: 1440
          alarmNotifyGroups:
            - alarm_notify_group_id: notify_group_id_xxxx
            - alarm_notify_group_id: notify_group_id_xxxx
          userDefineMsg: '{{toJson(QueryResult)}}{{UserName}}{{ProjectName}}{{Region}}{{Alarm}}{{AlarmID}}{{Topics|join:","}}{{toJson(Results[0].RawResultsCount)}}'
          joinConfigurations:
            - set_operation_type: CrossJoin
              condition: ""
            - set_operation_type: InnerJoin
              condition: $1. >= $3.
          sendResolved: false
          triggerConditions:
            - condition: ""
              count_condition: __count__ == 2
              no_data: false
              severity: warning
            - condition: $1.
              count_condition: ""
              no_data: false
              severity: critical
            - condition: $2.
              count_condition: __count__ == 4
              no_data: false
              severity: warning
            - condition: ""
              count_condition: ""
              no_data: true
              severity: critical
    
    Example 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,
              project_id: Optional[str] = None,
              alarm_notify_groups: Optional[Sequence[AlarmAlarmNotifyGroupArgs]] = None,
              trigger_period: Optional[int] = None,
              alarm_name: Optional[str] = None,
              request_cycle: Optional[AlarmRequestCycleArgs] = None,
              query_requests: Optional[Sequence[AlarmQueryRequestArgs]] = None,
              alarm_period_detail: Optional[AlarmAlarmPeriodDetailArgs] = None,
              join_configurations: Optional[Sequence[AlarmJoinConfigurationArgs]] = None,
              condition: Optional[str] = None,
              send_resolved: Optional[bool] = None,
              severity: Optional[str] = None,
              status: Optional[bool] = None,
              trigger_conditions: Optional[Sequence[AlarmTriggerConditionArgs]] = None,
              alarm_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: bytepluscc:tls:Alarm
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "bytepluscc_tls_alarm" "name" {
        # resource properties
    }

    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.

    Constructor example

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

    var alarmResource = new Bytepluscc.Tls.Alarm("alarmResource", new()
    {
        ProjectId = "string",
        AlarmNotifyGroups = new[]
        {
            new Bytepluscc.Tls.Inputs.AlarmAlarmNotifyGroupArgs
            {
                AlarmNotifyGroupId = "string",
            },
        },
        TriggerPeriod = 0,
        AlarmName = "string",
        RequestCycle = new Bytepluscc.Tls.Inputs.AlarmRequestCycleArgs
        {
            CronTab = "string",
            CronTimeZone = "string",
            Time = 0,
            Type = "string",
        },
        QueryRequests = new[]
        {
            new Bytepluscc.Tls.Inputs.AlarmQueryRequestArgs
            {
                EndTimeOffset = 0,
                EndTimeOffsetUnit = "string",
                Query = "string",
                StartTimeOffset = 0,
                StartTimeOffsetUnit = "string",
                TimeSpanType = "string",
                TopicId = "string",
                TopicName = "string",
                TruncatedTime = "string",
            },
        },
        AlarmPeriodDetail = new Bytepluscc.Tls.Inputs.AlarmAlarmPeriodDetailArgs
        {
            Email = 0,
            GeneralWebhook = 0,
            Phone = 0,
            Sms = 0,
        },
        JoinConfigurations = new[]
        {
            new Bytepluscc.Tls.Inputs.AlarmJoinConfigurationArgs
            {
                Condition = "string",
                SetOperationType = "string",
            },
        },
        Condition = "string",
        SendResolved = false,
        Severity = "string",
        Status = false,
        TriggerConditions = new[]
        {
            new Bytepluscc.Tls.Inputs.AlarmTriggerConditionArgs
            {
                Condition = "string",
                CountCondition = "string",
                NoData = false,
                Severity = "string",
            },
        },
        AlarmPeriod = 0,
        UserDefineMsg = "string",
    });
    
    example, err := tls.NewAlarm(ctx, "alarmResource", &tls.AlarmArgs{
    	ProjectId: pulumi.String("string"),
    	AlarmNotifyGroups: tls.AlarmAlarmNotifyGroupArray{
    		&tls.AlarmAlarmNotifyGroupArgs{
    			AlarmNotifyGroupId: pulumi.String("string"),
    		},
    	},
    	TriggerPeriod: pulumi.Int(0),
    	AlarmName:     pulumi.String("string"),
    	RequestCycle: &tls.AlarmRequestCycleArgs{
    		CronTab:      pulumi.String("string"),
    		CronTimeZone: pulumi.String("string"),
    		Time:         pulumi.Int(0),
    		Type:         pulumi.String("string"),
    	},
    	QueryRequests: tls.AlarmQueryRequestArray{
    		&tls.AlarmQueryRequestArgs{
    			EndTimeOffset:       pulumi.Int(0),
    			EndTimeOffsetUnit:   pulumi.String("string"),
    			Query:               pulumi.String("string"),
    			StartTimeOffset:     pulumi.Int(0),
    			StartTimeOffsetUnit: pulumi.String("string"),
    			TimeSpanType:        pulumi.String("string"),
    			TopicId:             pulumi.String("string"),
    			TopicName:           pulumi.String("string"),
    			TruncatedTime:       pulumi.String("string"),
    		},
    	},
    	AlarmPeriodDetail: &tls.AlarmAlarmPeriodDetailArgs{
    		Email:          pulumi.Int(0),
    		GeneralWebhook: pulumi.Int(0),
    		Phone:          pulumi.Int(0),
    		Sms:            pulumi.Int(0),
    	},
    	JoinConfigurations: tls.AlarmJoinConfigurationArray{
    		&tls.AlarmJoinConfigurationArgs{
    			Condition:        pulumi.String("string"),
    			SetOperationType: pulumi.String("string"),
    		},
    	},
    	Condition:    pulumi.String("string"),
    	SendResolved: pulumi.Bool(false),
    	Severity:     pulumi.String("string"),
    	Status:       pulumi.Bool(false),
    	TriggerConditions: tls.AlarmTriggerConditionArray{
    		&tls.AlarmTriggerConditionArgs{
    			Condition:      pulumi.String("string"),
    			CountCondition: pulumi.String("string"),
    			NoData:         pulumi.Bool(false),
    			Severity:       pulumi.String("string"),
    		},
    	},
    	AlarmPeriod:   pulumi.Int(0),
    	UserDefineMsg: pulumi.String("string"),
    })
    
    resource "bytepluscc_tls_alarm" "alarmResource" {
      project_id = "string"
      alarm_notify_groups {
        alarm_notify_group_id = "string"
      }
      trigger_period = 0
      alarm_name     = "string"
      request_cycle = {
        cron_tab       = "string"
        cron_time_zone = "string"
        time           = 0
        type           = "string"
      }
      query_requests {
        end_time_offset        = 0
        end_time_offset_unit   = "string"
        query                  = "string"
        start_time_offset      = 0
        start_time_offset_unit = "string"
        time_span_type         = "string"
        topic_id               = "string"
        topic_name             = "string"
        truncated_time         = "string"
      }
      alarm_period_detail = {
        email           = 0
        general_webhook = 0
        phone           = 0
        sms             = 0
      }
      join_configurations {
        condition          = "string"
        set_operation_type = "string"
      }
      condition     = "string"
      send_resolved = false
      severity      = "string"
      status        = false
      trigger_conditions {
        condition       = "string"
        count_condition = "string"
        no_data         = false
        severity        = "string"
      }
      alarm_period    = 0
      user_define_msg = "string"
    }
    
    var alarmResource = new Alarm("alarmResource", AlarmArgs.builder()
        .projectId("string")
        .alarmNotifyGroups(AlarmAlarmNotifyGroupArgs.builder()
            .alarmNotifyGroupId("string")
            .build())
        .triggerPeriod(0)
        .alarmName("string")
        .requestCycle(AlarmRequestCycleArgs.builder()
            .cronTab("string")
            .cronTimeZone("string")
            .time(0)
            .type("string")
            .build())
        .queryRequests(AlarmQueryRequestArgs.builder()
            .endTimeOffset(0)
            .endTimeOffsetUnit("string")
            .query("string")
            .startTimeOffset(0)
            .startTimeOffsetUnit("string")
            .timeSpanType("string")
            .topicId("string")
            .topicName("string")
            .truncatedTime("string")
            .build())
        .alarmPeriodDetail(AlarmAlarmPeriodDetailArgs.builder()
            .email(0)
            .generalWebhook(0)
            .phone(0)
            .sms(0)
            .build())
        .joinConfigurations(AlarmJoinConfigurationArgs.builder()
            .condition("string")
            .setOperationType("string")
            .build())
        .condition("string")
        .sendResolved(false)
        .severity("string")
        .status(false)
        .triggerConditions(AlarmTriggerConditionArgs.builder()
            .condition("string")
            .countCondition("string")
            .noData(false)
            .severity("string")
            .build())
        .alarmPeriod(0)
        .userDefineMsg("string")
        .build());
    
    alarm_resource = bytepluscc.tls.Alarm("alarmResource",
        project_id="string",
        alarm_notify_groups=[{
            "alarm_notify_group_id": "string",
        }],
        trigger_period=0,
        alarm_name="string",
        request_cycle={
            "cron_tab": "string",
            "cron_time_zone": "string",
            "time": 0,
            "type": "string",
        },
        query_requests=[{
            "end_time_offset": 0,
            "end_time_offset_unit": "string",
            "query": "string",
            "start_time_offset": 0,
            "start_time_offset_unit": "string",
            "time_span_type": "string",
            "topic_id": "string",
            "topic_name": "string",
            "truncated_time": "string",
        }],
        alarm_period_detail={
            "email": 0,
            "general_webhook": 0,
            "phone": 0,
            "sms": 0,
        },
        join_configurations=[{
            "condition": "string",
            "set_operation_type": "string",
        }],
        condition="string",
        send_resolved=False,
        severity="string",
        status=False,
        trigger_conditions=[{
            "condition": "string",
            "count_condition": "string",
            "no_data": False,
            "severity": "string",
        }],
        alarm_period=0,
        user_define_msg="string")
    
    const alarmResource = new bytepluscc.tls.Alarm("alarmResource", {
        projectId: "string",
        alarmNotifyGroups: [{
            alarmNotifyGroupId: "string",
        }],
        triggerPeriod: 0,
        alarmName: "string",
        requestCycle: {
            cronTab: "string",
            cronTimeZone: "string",
            time: 0,
            type: "string",
        },
        queryRequests: [{
            endTimeOffset: 0,
            endTimeOffsetUnit: "string",
            query: "string",
            startTimeOffset: 0,
            startTimeOffsetUnit: "string",
            timeSpanType: "string",
            topicId: "string",
            topicName: "string",
            truncatedTime: "string",
        }],
        alarmPeriodDetail: {
            email: 0,
            generalWebhook: 0,
            phone: 0,
            sms: 0,
        },
        joinConfigurations: [{
            condition: "string",
            setOperationType: "string",
        }],
        condition: "string",
        sendResolved: false,
        severity: "string",
        status: false,
        triggerConditions: [{
            condition: "string",
            countCondition: "string",
            noData: false,
            severity: "string",
        }],
        alarmPeriod: 0,
        userDefineMsg: "string",
    });
    
    type: bytepluscc:tls:Alarm
    properties:
        alarmName: string
        alarmNotifyGroups:
            - alarmNotifyGroupId: string
        alarmPeriod: 0
        alarmPeriodDetail:
            email: 0
            generalWebhook: 0
            phone: 0
            sms: 0
        condition: string
        joinConfigurations:
            - condition: string
              setOperationType: string
        projectId: string
        queryRequests:
            - endTimeOffset: 0
              endTimeOffsetUnit: string
              query: string
              startTimeOffset: 0
              startTimeOffsetUnit: string
              timeSpanType: string
              topicId: string
              topicName: string
              truncatedTime: string
        requestCycle:
            cronTab: string
            cronTimeZone: string
            time: 0
            type: string
        sendResolved: false
        severity: string
        status: false
        triggerConditions:
            - condition: string
              countCondition: string
              noData: false
              severity: string
        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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Alarm resource accepts the following input properties:

    AlarmName string
    Alert policy name
    AlarmNotifyGroups List<Byteplus.AlarmAlarmNotifyGroup>
    ProjectId string
    ID of the log project where the monitored log topic resides
    QueryRequests List<Byteplus.AlarmQueryRequest>
    RequestCycle Byteplus.AlarmRequestCycle
    Monitoring task execution statement.
    TriggerPeriod int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    AlarmPeriod int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    AlarmPeriodDetail Byteplus.AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    Condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    JoinConfigurations List<Byteplus.AlarmJoinConfiguration>
    SendResolved bool
    Enable alert policy. Default is true (enabled)
    Severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    Status bool
    Enable alert policy. Default is true (enabled)
    TriggerConditions List<Byteplus.AlarmTriggerCondition>
    UserDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    AlarmName string
    Alert policy name
    AlarmNotifyGroups []AlarmAlarmNotifyGroupArgs
    ProjectId string
    ID of the log project where the monitored log topic resides
    QueryRequests []AlarmQueryRequestArgs
    RequestCycle AlarmRequestCycleArgs
    Monitoring task execution statement.
    TriggerPeriod int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    AlarmPeriod int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    AlarmPeriodDetail AlarmAlarmPeriodDetailArgs
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    Condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    JoinConfigurations []AlarmJoinConfigurationArgs
    SendResolved bool
    Enable alert policy. Default is true (enabled)
    Severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    Status bool
    Enable alert policy. Default is true (enabled)
    TriggerConditions []AlarmTriggerConditionArgs
    UserDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarm_name string
    Alert policy name
    alarm_notify_groups list(object)
    project_id string
    ID of the log project where the monitored log topic resides
    query_requests list(object)
    request_cycle object
    Monitoring task execution statement.
    trigger_period number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    alarm_period number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarm_period_detail object
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    join_configurations list(object)
    send_resolved bool
    Enable alert policy. Default is true (enabled)
    severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status bool
    Enable alert policy. Default is true (enabled)
    trigger_conditions list(object)
    user_define_msg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmName String
    Alert policy name
    alarmNotifyGroups List<AlarmAlarmNotifyGroup>
    projectId String
    ID of the log project where the monitored log topic resides
    queryRequests List<AlarmQueryRequest>
    requestCycle AlarmRequestCycle
    Monitoring task execution statement.
    triggerPeriod Integer
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    alarmPeriod Integer
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition String
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    joinConfigurations List<AlarmJoinConfiguration>
    sendResolved Boolean
    Enable alert policy. Default is true (enabled)
    severity String
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status Boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions List<AlarmTriggerCondition>
    userDefineMsg String
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmName string
    Alert policy name
    alarmNotifyGroups AlarmAlarmNotifyGroup[]
    projectId string
    ID of the log project where the monitored log topic resides
    queryRequests AlarmQueryRequest[]
    requestCycle AlarmRequestCycle
    Monitoring task execution statement.
    triggerPeriod number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    alarmPeriod number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    joinConfigurations AlarmJoinConfiguration[]
    sendResolved boolean
    Enable alert policy. Default is true (enabled)
    severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions AlarmTriggerCondition[]
    userDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarm_name str
    Alert policy name
    alarm_notify_groups Sequence[AlarmAlarmNotifyGroupArgs]
    project_id str
    ID of the log project where the monitored log topic resides
    query_requests Sequence[AlarmQueryRequestArgs]
    request_cycle AlarmRequestCycleArgs
    Monitoring task execution statement.
    trigger_period int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    alarm_period int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarm_period_detail AlarmAlarmPeriodDetailArgs
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition str
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    join_configurations Sequence[AlarmJoinConfigurationArgs]
    send_resolved bool
    Enable alert policy. Default is true (enabled)
    severity str
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status bool
    Enable alert policy. Default is true (enabled)
    trigger_conditions Sequence[AlarmTriggerConditionArgs]
    user_define_msg str
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmName String
    Alert policy name
    alarmNotifyGroups List<Property Map>
    projectId String
    ID of the log project where the monitored log topic resides
    queryRequests List<Property Map>
    requestCycle Property Map
    Monitoring task execution statement.
    triggerPeriod Number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    alarmPeriod Number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail Property Map
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition String
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    joinConfigurations List<Property Map>
    sendResolved Boolean
    Enable alert policy. Default is true (enabled)
    severity String
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status Boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions List<Property Map>
    userDefineMsg String
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.

    Outputs

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

    AlarmId string
    Alert policy ID.
    CreateTime string
    Alert policy creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifyTime string
    Last modified time of the alert policy.
    AlarmId string
    Alert policy ID.
    CreateTime string
    Alert policy creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifyTime string
    Last modified time of the alert policy.
    alarm_id string
    Alert policy ID.
    create_time string
    Alert policy creation time
    id string
    The provider-assigned unique ID for this managed resource.
    modify_time string
    Last modified time of the alert policy.
    alarmId String
    Alert policy ID.
    createTime String
    Alert policy creation time
    id String
    The provider-assigned unique ID for this managed resource.
    modifyTime String
    Last modified time of the alert policy.
    alarmId string
    Alert policy ID.
    createTime string
    Alert policy creation time
    id string
    The provider-assigned unique ID for this managed resource.
    modifyTime string
    Last modified time of the alert policy.
    alarm_id str
    Alert policy ID.
    create_time str
    Alert policy creation time
    id str
    The provider-assigned unique ID for this managed resource.
    modify_time str
    Last modified time of the alert policy.
    alarmId String
    Alert policy ID.
    createTime String
    Alert policy creation time
    id String
    The provider-assigned unique ID for this managed resource.
    modifyTime String
    Last modified time of the alert policy.

    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[AlarmAlarmNotifyGroupArgs]] = None,
            alarm_period: Optional[int] = None,
            alarm_period_detail: Optional[AlarmAlarmPeriodDetailArgs] = None,
            condition: Optional[str] = None,
            create_time: Optional[str] = None,
            join_configurations: Optional[Sequence[AlarmJoinConfigurationArgs]] = None,
            modify_time: Optional[str] = None,
            project_id: Optional[str] = None,
            query_requests: Optional[Sequence[AlarmQueryRequestArgs]] = None,
            request_cycle: Optional[AlarmRequestCycleArgs] = None,
            send_resolved: Optional[bool] = None,
            severity: Optional[str] = None,
            status: Optional[bool] = None,
            trigger_conditions: Optional[Sequence[AlarmTriggerConditionArgs]] = 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)
    resources:  _:    type: bytepluscc:tls:Alarm    get:      id: ${id}
    import {
      to = bytepluscc_tls_alarm.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlarmId string
    Alert policy ID.
    AlarmName string
    Alert policy name
    AlarmNotifyGroups List<Byteplus.AlarmAlarmNotifyGroup>
    AlarmPeriod int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    AlarmPeriodDetail Byteplus.AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    Condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    CreateTime string
    Alert policy creation time
    JoinConfigurations List<Byteplus.AlarmJoinConfiguration>
    ModifyTime string
    Last modified time of the alert policy.
    ProjectId string
    ID of the log project where the monitored log topic resides
    QueryRequests List<Byteplus.AlarmQueryRequest>
    RequestCycle Byteplus.AlarmRequestCycle
    Monitoring task execution statement.
    SendResolved bool
    Enable alert policy. Default is true (enabled)
    Severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    Status bool
    Enable alert policy. Default is true (enabled)
    TriggerConditions List<Byteplus.AlarmTriggerCondition>
    TriggerPeriod int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    UserDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    AlarmId string
    Alert policy ID.
    AlarmName string
    Alert policy name
    AlarmNotifyGroups []AlarmAlarmNotifyGroupArgs
    AlarmPeriod int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    AlarmPeriodDetail AlarmAlarmPeriodDetailArgs
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    Condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    CreateTime string
    Alert policy creation time
    JoinConfigurations []AlarmJoinConfigurationArgs
    ModifyTime string
    Last modified time of the alert policy.
    ProjectId string
    ID of the log project where the monitored log topic resides
    QueryRequests []AlarmQueryRequestArgs
    RequestCycle AlarmRequestCycleArgs
    Monitoring task execution statement.
    SendResolved bool
    Enable alert policy. Default is true (enabled)
    Severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    Status bool
    Enable alert policy. Default is true (enabled)
    TriggerConditions []AlarmTriggerConditionArgs
    TriggerPeriod int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    UserDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarm_id string
    Alert policy ID.
    alarm_name string
    Alert policy name
    alarm_notify_groups list(object)
    alarm_period number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarm_period_detail object
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    create_time string
    Alert policy creation time
    join_configurations list(object)
    modify_time string
    Last modified time of the alert policy.
    project_id string
    ID of the log project where the monitored log topic resides
    query_requests list(object)
    request_cycle object
    Monitoring task execution statement.
    send_resolved bool
    Enable alert policy. Default is true (enabled)
    severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status bool
    Enable alert policy. Default is true (enabled)
    trigger_conditions list(object)
    trigger_period number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    user_define_msg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmId String
    Alert policy ID.
    alarmName String
    Alert policy name
    alarmNotifyGroups List<AlarmAlarmNotifyGroup>
    alarmPeriod Integer
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition String
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    createTime String
    Alert policy creation time
    joinConfigurations List<AlarmJoinConfiguration>
    modifyTime String
    Last modified time of the alert policy.
    projectId String
    ID of the log project where the monitored log topic resides
    queryRequests List<AlarmQueryRequest>
    requestCycle AlarmRequestCycle
    Monitoring task execution statement.
    sendResolved Boolean
    Enable alert policy. Default is true (enabled)
    severity String
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status Boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions List<AlarmTriggerCondition>
    triggerPeriod Integer
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    userDefineMsg String
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmId string
    Alert policy ID.
    alarmName string
    Alert policy name
    alarmNotifyGroups AlarmAlarmNotifyGroup[]
    alarmPeriod number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail AlarmAlarmPeriodDetail
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition string
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    createTime string
    Alert policy creation time
    joinConfigurations AlarmJoinConfiguration[]
    modifyTime string
    Last modified time of the alert policy.
    projectId string
    ID of the log project where the monitored log topic resides
    queryRequests AlarmQueryRequest[]
    requestCycle AlarmRequestCycle
    Monitoring task execution statement.
    sendResolved boolean
    Enable alert policy. Default is true (enabled)
    severity string
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions AlarmTriggerCondition[]
    triggerPeriod number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    userDefineMsg string
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarm_id str
    Alert policy ID.
    alarm_name str
    Alert policy name
    alarm_notify_groups Sequence[AlarmAlarmNotifyGroupArgs]
    alarm_period int
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarm_period_detail AlarmAlarmPeriodDetailArgs
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition str
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    create_time str
    Alert policy creation time
    join_configurations Sequence[AlarmJoinConfigurationArgs]
    modify_time str
    Last modified time of the alert policy.
    project_id str
    ID of the log project where the monitored log topic resides
    query_requests Sequence[AlarmQueryRequestArgs]
    request_cycle AlarmRequestCycleArgs
    Monitoring task execution statement.
    send_resolved bool
    Enable alert policy. Default is true (enabled)
    severity str
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status bool
    Enable alert policy. Default is true (enabled)
    trigger_conditions Sequence[AlarmTriggerConditionArgs]
    trigger_period int
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    user_define_msg str
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.
    alarmId String
    Alert policy ID.
    alarmName String
    Alert policy name
    alarmNotifyGroups List<Property Map>
    alarmPeriod Number
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod limit, the log service sends alert notifications at the specified interval. Value range: 10–1440, unit: minutes. This parameter sets the sending interval for alert notifications across all channels. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence.
    alarmPeriodDetail Property Map
    Alert notification sending interval. When the alert is triggered continuously and reaches the specified TriggerPeriod, the logging service sends alert notifications according to the specified interval. Value range: 10–1440, in minutes. This parameter is used to set the sending interval for each channel. AlarmPeriod and AlarmPeriodDetail cannot both be empty. If both are specified, AlarmPeriodDetail takes precedence
    condition String
    Alert trigger conditions. Alert policies support referencing query analysis results using the $N.keyname expression. If you configure the TriggerConditions field, the Condition and Severity fields will be ignored. If you do not configure the TriggerConditions field, both Condition and Severity fields are required.
    createTime String
    Alert policy creation time
    joinConfigurations List<Property Map>
    modifyTime String
    Last modified time of the alert policy.
    projectId String
    ID of the log project where the monitored log topic resides
    queryRequests List<Property Map>
    requestCycle Property Map
    Monitoring task execution statement.
    sendResolved Boolean
    Enable alert policy. Default is true (enabled)
    severity String
    Alert notification level, indicating the severity of the alert. Supported values: notice, warning, or critical. Default is notice
    status Boolean
    Enable alert policy. Default is true (enabled)
    triggerConditions List<Property Map>
    triggerPeriod Number
    Duration period. An alert is triggered after the trigger condition is continuously met for TriggerPeriod cycles. Minimum value: 1, maximum value: 10, default is 1.
    userDefineMsg String
    Customize alert notification content. You can insert content variables and functions. For details, see the documentation for content variables and content functions. To display this content in the actual alert notification, reference it in the content template using the NotifyMsg variable.

    Supporting Types

    AlarmAlarmNotifyGroup, AlarmAlarmNotifyGroupArgs

    AlarmNotifyGroupId string
    Alert notification group ID.
    AlarmNotifyGroupId string
    Alert notification group ID.
    alarm_notify_group_id string
    Alert notification group ID.
    alarmNotifyGroupId String
    Alert notification group ID.
    alarmNotifyGroupId string
    Alert notification group ID.
    alarm_notify_group_id str
    Alert notification group ID.
    alarmNotifyGroupId String
    Alert notification group ID.

    AlarmAlarmPeriodDetail, AlarmAlarmPeriodDetailArgs

    Email int
    Email alert interval, in minutes. Value range: 1–1440
    GeneralWebhook int
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    Phone int
    Phone alert cycle, in minutes. Value range: 10–1440.
    Sms int
    SMS alert interval, in minutes. Value range: 10–1440
    Email int
    Email alert interval, in minutes. Value range: 1–1440
    GeneralWebhook int
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    Phone int
    Phone alert cycle, in minutes. Value range: 10–1440.
    Sms int
    SMS alert interval, in minutes. Value range: 10–1440
    email number
    Email alert interval, in minutes. Value range: 1–1440
    general_webhook number
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    phone number
    Phone alert cycle, in minutes. Value range: 10–1440.
    sms number
    SMS alert interval, in minutes. Value range: 10–1440
    email Integer
    Email alert interval, in minutes. Value range: 1–1440
    generalWebhook Integer
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    phone Integer
    Phone alert cycle, in minutes. Value range: 10–1440.
    sms Integer
    SMS alert interval, in minutes. Value range: 10–1440
    email number
    Email alert interval, in minutes. Value range: 1–1440
    generalWebhook number
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    phone number
    Phone alert cycle, in minutes. Value range: 10–1440.
    sms number
    SMS alert interval, in minutes. Value range: 10–1440
    email int
    Email alert interval, in minutes. Value range: 1–1440
    general_webhook int
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    phone int
    Phone alert cycle, in minutes. Value range: 10–1440.
    sms int
    SMS alert interval, in minutes. Value range: 10–1440
    email Number
    Email alert interval, in minutes. Value range: 1–1440
    generalWebhook Number
    Custom Webhook alert interval, in minutes. Value range: 1–1440.
    phone Number
    Phone alert cycle, in minutes. Value range: 10–1440.
    sms Number
    SMS alert interval, in minutes. Value range: 10–1440

    AlarmJoinConfiguration, AlarmJoinConfigurationArgs

    Condition string
    Expression used for left join or right join.
    SetOperationType string
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    Condition string
    Expression used for left join or right join.
    SetOperationType string
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    condition string
    Expression used for left join or right join.
    set_operation_type string
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    condition String
    Expression used for left join or right join.
    setOperationType String
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    condition string
    Expression used for left join or right join.
    setOperationType string
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    condition str
    Expression used for left join or right join.
    set_operation_type str
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
    condition String
    Expression used for left join or right join.
    setOperationType String
    Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.

    AlarmQueryRequest, AlarmQueryRequestArgs

    EndTimeOffset int
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    EndTimeOffsetUnit string
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    Query string
    Query analysis statement, with a maximum supported length of 1024 characters.
    StartTimeOffset int
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    StartTimeOffsetUnit string
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    TimeSpanType string
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    TopicId string
    Log topic ID monitored by the alert policy.
    TopicName string
    Name of the log topic monitored by the alert policy.
    TruncatedTime string
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    EndTimeOffset int
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    EndTimeOffsetUnit string
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    Query string
    Query analysis statement, with a maximum supported length of 1024 characters.
    StartTimeOffset int
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    StartTimeOffsetUnit string
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    TimeSpanType string
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    TopicId string
    Log topic ID monitored by the alert policy.
    TopicName string
    Name of the log topic monitored by the alert policy.
    TruncatedTime string
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    end_time_offset number
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    end_time_offset_unit string
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    query string
    Query analysis statement, with a maximum supported length of 1024 characters.
    start_time_offset number
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    start_time_offset_unit string
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    time_span_type string
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    topic_id string
    Log topic ID monitored by the alert policy.
    topic_name string
    Name of the log topic monitored by the alert policy.
    truncated_time string
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    endTimeOffset Integer
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    endTimeOffsetUnit String
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    query String
    Query analysis statement, with a maximum supported length of 1024 characters.
    startTimeOffset Integer
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    startTimeOffsetUnit String
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    timeSpanType String
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    topicId String
    Log topic ID monitored by the alert policy.
    topicName String
    Name of the log topic monitored by the alert policy.
    truncatedTime String
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    endTimeOffset number
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    endTimeOffsetUnit string
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    query string
    Query analysis statement, with a maximum supported length of 1024 characters.
    startTimeOffset number
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    startTimeOffsetUnit string
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    timeSpanType string
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    topicId string
    Log topic ID monitored by the alert policy.
    topicName string
    Name of the log topic monitored by the alert policy.
    truncatedTime string
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    end_time_offset int
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    end_time_offset_unit str
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    query str
    Query analysis statement, with a maximum supported length of 1024 characters.
    start_time_offset int
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    start_time_offset_unit str
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    time_span_type str
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    topic_id str
    Log topic ID monitored by the alert policy.
    topic_name str
    Name of the log topic monitored by the alert policy.
    truncated_time str
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).
    endTimeOffset Number
    Query end time, relative to the current time, in minutes. Value must be a non-positive integer and greater than StartTimeOffset. Maximum: 0, minimum: -1440
    endTimeOffsetUnit String
    Unit for the end time range of the query. Default is minutes. Supports second/minute/hour (Second, Minute, Hour).
    query String
    Query analysis statement, with a maximum supported length of 1024 characters.
    startTimeOffset Number
    Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
    startTimeOffsetUnit String
    Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
    timeSpanType String
    Whether to use on-the-hour time for the query. If left blank, defaults to Relative.
    topicId String
    Log topic ID monitored by the alert policy.
    topicName String
    Name of the log topic monitored by the alert policy.
    truncatedTime String
    Round time values, i.e., round to the nearest minute or hour (Second, Minute, Hour).

    AlarmRequestCycle, AlarmRequestCycleArgs

    CronTab string
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    CronTimeZone string
    Time zone in which the Cron expression takes effect.
    Time int
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    Type string
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    CronTab string
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    CronTimeZone string
    Time zone in which the Cron expression takes effect.
    Time int
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    Type string
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    cron_tab string
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    cron_time_zone string
    Time zone in which the Cron expression takes effect.
    time number
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    type string
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    cronTab String
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    cronTimeZone String
    Time zone in which the Cron expression takes effect.
    time Integer
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    type String
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    cronTab string
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    cronTimeZone string
    Time zone in which the Cron expression takes effect.
    time number
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    type string
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    cron_tab str
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    cron_time_zone str
    Time zone in which the Cron expression takes effect.
    time int
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    type str
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.
    cronTab String
    Cron expression. Log Service uses a Cron expression to specify the scheduled execution of alert tasks. The minimum granularity is one minute, using a 24-hour format. For example, 0 18 * * * means the alert task runs once daily at 18:00.
    cronTimeZone String
    Time zone in which the Cron expression takes effect.
    time Number
    Scheduling cycle or the specific time point for periodic execution (minutes from 00:00). Value range: 1–1440, in minutes.
    type String
    Scheduling interval type. Options: Period: schedule at regular intervals. Fixed: schedule at a fixed time each day. Cron: use a Cron expression.

    AlarmTriggerCondition, AlarmTriggerConditionArgs

    Condition string
    Alert trigger condition expression.
    CountCondition string
    Numerical expression for scenarios with data or specific entries, implemented using count.
    NoData bool
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    Severity string
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    Condition string
    Alert trigger condition expression.
    CountCondition string
    Numerical expression for scenarios with data or specific entries, implemented using count.
    NoData bool
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    Severity string
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    condition string
    Alert trigger condition expression.
    count_condition string
    Numerical expression for scenarios with data or specific entries, implemented using count.
    no_data bool
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    severity string
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    condition String
    Alert trigger condition expression.
    countCondition String
    Numerical expression for scenarios with data or specific entries, implemented using count.
    noData Boolean
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    severity String
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    condition string
    Alert trigger condition expression.
    countCondition string
    Numerical expression for scenarios with data or specific entries, implemented using count.
    noData boolean
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    severity string
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    condition str
    Alert trigger condition expression.
    count_condition str
    Numerical expression for scenarios with data or specific entries, implemented using count.
    no_data bool
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    severity str
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.
    condition String
    Alert trigger condition expression.
    countCondition String
    Numerical expression for scenarios with data or specific entries, implemented using count.
    noData Boolean
    When enabled, if the result after set operations is an empty set, a separate no-data alert is triggered.
    severity String
    Alert notification level, indicating the severity of the alert. Supports notice, warning, or critical, with severity increasing in that order. The default is notice.

    Import

    $ pulumi import bytepluscc:tls/alarm:Alarm example "alarm_id"
    

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.30
    published on Monday, May 25, 2026 by Byteplus

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial