published on Monday, May 25, 2026 by Byteplus
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)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:
- Alarm
Name string - Alert policy name
- Alarm
Notify List<Byteplus.Groups Alarm Alarm Notify Group> - Project
Id string - ID of the log project where the monitored log topic resides
- Query
Requests List<Byteplus.Alarm Query Request> - Request
Cycle Byteplus.Alarm Request Cycle - 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 Byteplus.Detail Alarm Alarm Period Detail - 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<Byteplus.Alarm Join Configuration> - 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<Byteplus.Alarm Trigger Condition> - User
Define stringMsg - 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 []AlarmGroups Alarm Notify Group Args - Project
Id string - ID of the log project where the monitored log topic resides
- Query
Requests []AlarmQuery Request Args - Request
Cycle AlarmRequest Cycle Args - 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 AlarmDetail Alarm Period Detail Args - 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 []AlarmJoin Configuration Args - 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 []AlarmTrigger Condition Args - User
Define stringMsg - 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_ list(object)groups - 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_ objectdetail - 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_ stringmsg - 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 List<AlarmGroups Alarm Notify Group> - project
Id String - ID of the log project where the monitored log topic resides
- query
Requests List<AlarmQuery Request> - request
Cycle AlarmRequest Cycle - Monitoring task execution statement.
- trigger
Period 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.
- alarm
Period 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.
- alarm
Period AlarmDetail Alarm Period Detail - 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<AlarmJoin Configuration> - send
Resolved 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)
- trigger
Conditions List<AlarmTrigger Condition> - user
Define StringMsg - 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 AlarmGroups Alarm Notify Group[] - project
Id string - ID of the log project where the monitored log topic resides
- query
Requests AlarmQuery Request[] - request
Cycle AlarmRequest Cycle - 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 AlarmDetail Alarm Period Detail - 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 AlarmJoin Configuration[] - send
Resolved 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)
- trigger
Conditions AlarmTrigger Condition[] - user
Define stringMsg - 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_ Sequence[Alarmgroups Alarm Notify Group Args] - project_
id str - ID of the log project where the monitored log topic resides
- query_
requests Sequence[AlarmQuery Request Args] - request_
cycle AlarmRequest Cycle Args - 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_ Alarmdetail Alarm Period Detail Args - 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[AlarmJoin Configuration Args] - 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[AlarmTrigger Condition Args] - user_
define_ strmsg - 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 List<Property Map>Groups - project
Id String - ID of the log project where the monitored log topic resides
- query
Requests List<Property Map> - request
Cycle Property Map - 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 Property MapDetail - 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<Property Map> - send
Resolved 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)
- trigger
Conditions List<Property Map> - user
Define StringMsg - 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:
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
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) -> Alarmfunc 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.
- Alarm
Id string - Alert policy ID.
- Alarm
Name string - Alert policy name
- Alarm
Notify List<Byteplus.Groups Alarm Alarm Notify Group> - 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 Byteplus.Detail Alarm Alarm Period Detail - 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<Byteplus.Alarm Join Configuration> - 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<Byteplus.Alarm Query Request> - Request
Cycle Byteplus.Alarm Request Cycle - 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<Byteplus.Alarm Trigger Condition> - 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 stringMsg - 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 []AlarmGroups Alarm Notify Group Args - 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 AlarmDetail Alarm Period Detail Args - 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 []AlarmJoin Configuration Args - 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 []AlarmQuery Request Args - Request
Cycle AlarmRequest Cycle Args - 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 []AlarmTrigger Condition Args - 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 stringMsg - 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_ list(object)groups - 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_ objectdetail - 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_ stringmsg - 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 List<AlarmGroups Alarm Notify Group> - alarm
Period 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.
- alarm
Period AlarmDetail Alarm Period Detail - 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<AlarmJoin Configuration> - 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<AlarmQuery Request> - request
Cycle AlarmRequest Cycle - Monitoring task execution statement.
- send
Resolved 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)
- trigger
Conditions List<AlarmTrigger Condition> - trigger
Period 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.
- user
Define StringMsg - 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 AlarmGroups Alarm Notify Group[] - 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 AlarmDetail Alarm Period Detail - 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 AlarmJoin Configuration[] - 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 AlarmQuery Request[] - request
Cycle AlarmRequest Cycle - Monitoring task execution statement.
- send
Resolved 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)
- trigger
Conditions AlarmTrigger Condition[] - 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 stringMsg - 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_ Sequence[Alarmgroups Alarm Notify Group Args] - 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_ Alarmdetail Alarm Period Detail Args - 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[AlarmJoin Configuration Args] - 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[AlarmQuery Request Args] - request_
cycle AlarmRequest Cycle Args - 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[AlarmTrigger Condition Args] - 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_ strmsg - 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 List<Property Map>Groups - 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 Property MapDetail - 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<Property Map> - 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<Property Map> - request
Cycle Property Map - Monitoring task execution statement.
- send
Resolved 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)
- trigger
Conditions List<Property Map> - 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 StringMsg - 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
- Alarm
Notify stringGroup Id - Alert notification group ID.
- Alarm
Notify stringGroup Id - Alert notification group ID.
- alarm_
notify_ stringgroup_ id - Alert notification group ID.
- alarm
Notify StringGroup Id - Alert notification group ID.
- alarm
Notify stringGroup Id - Alert notification group ID.
- alarm_
notify_ strgroup_ id - Alert notification group ID.
- alarm
Notify StringGroup Id - Alert notification group ID.
AlarmAlarmPeriodDetail, AlarmAlarmPeriodDetailArgs
- 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 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
- 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
- general
Webhook 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
- 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 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
- 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
AlarmJoinConfiguration, AlarmJoinConfigurationArgs
- Condition string
- Expression used for left join or right join.
- Set
Operation stringType - 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 stringType - 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_ stringtype - 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 StringType - 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 stringType - 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_ strtype - 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 StringType - Set operation type. Optional values: CrossJoin: Cartesian product. LeftJoin: Left join. RightJoin: Right join. InnerJoin: Inner join. FullJoin: Full join.
AlarmQueryRequest, AlarmQueryRequestArgs
- End
Time intOffset - 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 stringOffset Unit - 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 intOffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- Start
Time stringOffset Unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- Time
Span stringType - 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).
- End
Time intOffset - 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 stringOffset Unit - 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 intOffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- Start
Time stringOffset Unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- Time
Span stringType - 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).
- end_
time_ numberoffset - 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_ stringoffset_ unit - 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_ numberoffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- start_
time_ stringoffset_ unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- time_
span_ stringtype - 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).
- end
Time IntegerOffset - 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 StringOffset Unit - 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 IntegerOffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- start
Time StringOffset Unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- time
Span StringType - 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).
- end
Time numberOffset - 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 stringOffset Unit - 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 numberOffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- start
Time stringOffset Unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- time
Span stringType - 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).
- end_
time_ intoffset - 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_ stroffset_ unit - 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_ intoffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- start_
time_ stroffset_ unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- time_
span_ strtype - 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).
- end
Time NumberOffset - 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 StringOffset Unit - 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 NumberOffset - Query start time, relative to the current time, in minutes. Value must be a non-positive integer. Maximum: 0, minimum: -1440
- start
Time StringOffset Unit - Unit for the query start time range. The default is minutes. Supports seconds/minutes/hours (Second, Minute, Hour).
- time
Span StringType - 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).
AlarmRequestCycle, AlarmRequestCycleArgs
- 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 stringZone - 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 stringZone - 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_ stringzone - 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 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 StringZone - 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.
- 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 stringZone - 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_ strzone - 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.
- 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 StringZone - 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.
- 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.
- 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.
- 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.
- count
Condition String - Numerical expression for scenarios with data or specific entries, implemented using count.
- no
Data 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.
- count
Condition string - Numerical expression for scenarios with data or specific entries, implemented using count.
- no
Data 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.
- count
Condition String - Numerical expression for scenarios with data or specific entries, implemented using count.
- no
Data 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
byteplusccTerraform Provider.
published on Monday, May 25, 2026 by Byteplus