Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine.tls.Alarms
Explore with Pulumi AI
Use this data source to query detailed information of tls alarms
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var @default = Volcengine.Tls.Alarms.Invoke(new()
{
ProjectId = "cc44f8b6-0328-4622-b043-023fca735cd4",
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tls.Alarms(ctx, &tls.AlarmsArgs{
ProjectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.AlarmsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var default = TlsFunctions.Alarms(AlarmsArgs.builder()
.projectId("cc44f8b6-0328-4622-b043-023fca735cd4")
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
default = volcengine.tls.alarms(project_id="cc44f8b6-0328-4622-b043-023fca735cd4")
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const default = volcengine.tls.Alarms({
projectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
});
variables:
default:
fn::invoke:
Function: volcengine:tls:Alarms
Arguments:
projectId: cc44f8b6-0328-4622-b043-023fca735cd4
Using Alarms
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function alarms(args: AlarmsArgs, opts?: InvokeOptions): Promise<AlarmsResult>
function alarmsOutput(args: AlarmsOutputArgs, opts?: InvokeOptions): Output<AlarmsResult>
def alarms(alarm_id: Optional[str] = None,
alarm_name: Optional[str] = None,
output_file: Optional[str] = None,
project_id: Optional[str] = None,
status: Optional[bool] = None,
topic_id: Optional[str] = None,
topic_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> AlarmsResult
def alarms_output(alarm_id: Optional[pulumi.Input[str]] = None,
alarm_name: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
status: Optional[pulumi.Input[bool]] = None,
topic_id: Optional[pulumi.Input[str]] = None,
topic_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[AlarmsResult]
func Alarms(ctx *Context, args *AlarmsArgs, opts ...InvokeOption) (*AlarmsResult, error)
func AlarmsOutput(ctx *Context, args *AlarmsOutputArgs, opts ...InvokeOption) AlarmsResultOutput
public static class Alarms
{
public static Task<AlarmsResult> InvokeAsync(AlarmsArgs args, InvokeOptions? opts = null)
public static Output<AlarmsResult> Invoke(AlarmsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<AlarmsResult> alarms(AlarmsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: volcengine:tls:Alarms
arguments:
# arguments dictionary
The following arguments are supported:
- project_
id str - The project id.
- alarm_
id str - The alarm id.
- alarm_
name str - The alarm name.
- output_
file str - File name where to save data source results.
- status bool
- The status.
- topic_
id str - The topic id.
- topic_
name str - The topic name.
Alarms Result
The following output properties are available:
- Alarms
List<Alarms
Alarm> - The list of alarms.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The project id.
- Total
Count int - The total count of query.
- Alarm
Id string - The alarm id.
- Alarm
Name string - The name of the alarm.
- Output
File string - Status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- Topic
Id string - The id of the topic.
- Topic
Name string - The name of the topic.
- Alarms
[]Alarms
Alarm - The list of alarms.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The project id.
- Total
Count int - The total count of query.
- Alarm
Id string - The alarm id.
- Alarm
Name string - The name of the alarm.
- Output
File string - Status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- Topic
Id string - The id of the topic.
- Topic
Name string - The name of the topic.
- alarms
List<Alarms
Alarm> - The list of alarms.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The project id.
- total
Count Integer - The total count of query.
- alarm
Id String - The alarm id.
- alarm
Name String - The name of the alarm.
- output
File String - status Boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topic
Id String - The id of the topic.
- topic
Name String - The name of the topic.
- alarms
Alarms
Alarm[] - The list of alarms.
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - The project id.
- total
Count number - The total count of query.
- alarm
Id string - The alarm id.
- alarm
Name string - The name of the alarm.
- output
File string - status boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topic
Id string - The id of the topic.
- topic
Name string - The name of the topic.
- alarms
Sequence[Alarms
Alarm] - The list of alarms.
- id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - The project id.
- total_
count int - The total count of query.
- alarm_
id str - The alarm id.
- alarm_
name str - The name of the alarm.
- output_
file str - status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- topic_
id str - The id of the topic.
- topic_
name str - The name of the topic.
- alarms List<Property Map>
- The list of alarms.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The project id.
- total
Count Number - The total count of query.
- alarm
Id String - The alarm id.
- alarm
Name String - The name of the alarm.
- output
File String - status Boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topic
Id String - The id of the topic.
- topic
Name String - The name of the topic.
Supporting Types
AlarmsAlarm
- Alarm
Id string - The alarm id.
- Alarm
Name string - The alarm name.
- Alarm
Notify List<AlarmsGroups Alarm Alarm Notify Group> - List of notification groups corresponding to the alarm.
- Alarm
Period int - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Alarm
Period List<AlarmsDetails Alarm Alarm Period Detail> - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Condition string
- Alarm trigger condition.
- Create
Time string - The create time.
- Modify
Time string - The modify time.
- Project
Id string - The project id.
- Query
Requests List<AlarmsAlarm Query Request> - Search and analyze sentences, 1~3 can be configured.
- Request
Cycles List<AlarmsAlarm Request Cycle> - The execution period of the alarm task.
- Status bool
- The status.
- Trigger
Period int - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- User
Define stringMsg - Customize the alarm notification content.
- Alarm
Id string - The alarm id.
- Alarm
Name string - The alarm name.
- Alarm
Notify []AlarmsGroups Alarm Alarm Notify Group - List of notification groups corresponding to the alarm.
- Alarm
Period int - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Alarm
Period []AlarmsDetails Alarm Alarm Period Detail - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Condition string
- Alarm trigger condition.
- Create
Time string - The create time.
- Modify
Time string - The modify time.
- Project
Id string - The project id.
- Query
Requests []AlarmsAlarm Query Request - Search and analyze sentences, 1~3 can be configured.
- Request
Cycles []AlarmsAlarm Request Cycle - The execution period of the alarm task.
- Status bool
- The status.
- Trigger
Period int - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- User
Define stringMsg - Customize the alarm notification content.
- alarm
Id String - The alarm id.
- alarm
Name String - The alarm name.
- alarm
Notify List<AlarmsGroups Alarm Alarm Notify Group> - List of notification groups corresponding to the alarm.
- alarm
Period Integer - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarm
Period List<AlarmsDetails Alarm Alarm Period Detail> - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition String
- Alarm trigger condition.
- create
Time String - The create time.
- modify
Time String - The modify time.
- project
Id String - The project id.
- query
Requests List<AlarmsAlarm Query Request> - Search and analyze sentences, 1~3 can be configured.
- request
Cycles List<AlarmsAlarm Request Cycle> - The execution period of the alarm task.
- status Boolean
- The status.
- trigger
Period Integer - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- user
Define StringMsg - Customize the alarm notification content.
- alarm
Id string - The alarm id.
- alarm
Name string - The alarm name.
- alarm
Notify AlarmsGroups Alarm Alarm Notify Group[] - List of notification groups corresponding to the alarm.
- alarm
Period number - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarm
Period AlarmsDetails Alarm Alarm Period Detail[] - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition string
- Alarm trigger condition.
- create
Time string - The create time.
- modify
Time string - The modify time.
- project
Id string - The project id.
- query
Requests AlarmsAlarm Query Request[] - Search and analyze sentences, 1~3 can be configured.
- request
Cycles AlarmsAlarm Request Cycle[] - The execution period of the alarm task.
- status boolean
- The status.
- trigger
Period number - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- user
Define stringMsg - Customize the alarm notification content.
- alarm_
id str - The alarm id.
- alarm_
name str - The alarm name.
- alarm_
notify_ Sequence[Alarmsgroups Alarm Alarm Notify Group] - List of notification groups corresponding to the alarm.
- alarm_
period int - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarm_
period_ Sequence[Alarmsdetails Alarm Alarm Period Detail] - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition str
- Alarm trigger condition.
- create_
time str - The create time.
- modify_
time str - The modify time.
- project_
id str - The project id.
- query_
requests Sequence[AlarmsAlarm Query Request] - Search and analyze sentences, 1~3 can be configured.
- request_
cycles Sequence[AlarmsAlarm Request Cycle] - The execution period of the alarm task.
- status bool
- The status.
- trigger_
period int - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- user_
define_ strmsg - Customize the alarm notification content.
- alarm
Id String - The alarm id.
- alarm
Name String - The alarm name.
- alarm
Notify List<Property Map>Groups - List of notification groups corresponding to the alarm.
- alarm
Period Number - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarm
Period List<Property Map>Details - Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition String
- Alarm trigger condition.
- create
Time String - The create time.
- modify
Time String - The modify time.
- project
Id String - The project id.
- query
Requests List<Property Map> - Search and analyze sentences, 1~3 can be configured.
- request
Cycles List<Property Map> - The execution period of the alarm task.
- status Boolean
- The status.
- trigger
Period Number - Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- user
Define StringMsg - Customize the alarm notification content.
AlarmsAlarmAlarmNotifyGroup
- Alarm
Notify stringGroup Id - The id of the notify group.
- Alarm
Notify stringGroup Name - Name of the notification group.
- Create
Time string - The create time.
- Iam
Project stringName - The iam project name.
- Modify
Time string - The modify time.
- Notify
Types List<string> - The notify group type.
- Receivers
List<Alarms
Alarm Alarm Notify Group Receiver> - List of IAM users to receive alerts.
- Alarm
Notify stringGroup Id - The id of the notify group.
- Alarm
Notify stringGroup Name - Name of the notification group.
- Create
Time string - The create time.
- Iam
Project stringName - The iam project name.
- Modify
Time string - The modify time.
- Notify
Types []string - The notify group type.
- Receivers
[]Alarms
Alarm Alarm Notify Group Receiver - List of IAM users to receive alerts.
- alarm
Notify StringGroup Id - The id of the notify group.
- alarm
Notify StringGroup Name - Name of the notification group.
- create
Time String - The create time.
- iam
Project StringName - The iam project name.
- modify
Time String - The modify time.
- notify
Types List<String> - The notify group type.
- receivers
List<Alarms
Alarm Alarm Notify Group Receiver> - List of IAM users to receive alerts.
- alarm
Notify stringGroup Id - The id of the notify group.
- alarm
Notify stringGroup Name - Name of the notification group.
- create
Time string - The create time.
- iam
Project stringName - The iam project name.
- modify
Time string - The modify time.
- notify
Types string[] - The notify group type.
- receivers
Alarms
Alarm Alarm Notify Group Receiver[] - List of IAM users to receive alerts.
- alarm_
notify_ strgroup_ id - The id of the notify group.
- alarm_
notify_ strgroup_ name - Name of the notification group.
- create_
time str - The create time.
- iam_
project_ strname - The iam project name.
- modify_
time str - The modify time.
- notify_
types Sequence[str] - The notify group type.
- receivers
Sequence[Alarms
Alarm Alarm Notify Group Receiver] - List of IAM users to receive alerts.
- alarm
Notify StringGroup Id - The id of the notify group.
- alarm
Notify StringGroup Name - Name of the notification group.
- create
Time String - The create time.
- iam
Project StringName - The iam project name.
- modify
Time String - The modify time.
- notify
Types List<String> - The notify group type.
- receivers List<Property Map>
- List of IAM users to receive alerts.
AlarmsAlarmAlarmNotifyGroupReceiver
- End
Time string - The end time.
- Receiver
Channels List<string> - The list of the receiver channels.
- Receiver
Names List<string> - List of the receiver names.
- Receiver
Type string - The receiver type.
- Start
Time string - The start time.
- End
Time string - The end time.
- Receiver
Channels []string - The list of the receiver channels.
- Receiver
Names []string - List of the receiver names.
- Receiver
Type string - The receiver type.
- Start
Time string - The start time.
- end
Time String - The end time.
- receiver
Channels List<String> - The list of the receiver channels.
- receiver
Names List<String> - List of the receiver names.
- receiver
Type String - The receiver type.
- start
Time String - The start time.
- end
Time string - The end time.
- receiver
Channels string[] - The list of the receiver channels.
- receiver
Names string[] - List of the receiver names.
- receiver
Type string - The receiver type.
- start
Time string - The start time.
- end_
time str - The end time.
- receiver_
channels Sequence[str] - The list of the receiver channels.
- receiver_
names Sequence[str] - List of the receiver names.
- receiver_
type str - The receiver type.
- start_
time str - The start time.
- end
Time String - The end time.
- receiver
Channels List<String> - The list of the receiver channels.
- receiver
Names List<String> - List of the receiver names.
- receiver
Type String - The receiver type.
- start
Time String - The start time.
AlarmsAlarmAlarmPeriodDetail
- Email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- General
Webhook int - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- Phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- Sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- Email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- General
Webhook int - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- Phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- Sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email Integer
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- general
Webhook Integer - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone Integer
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms Integer
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email number
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- general
Webhook number - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone number
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms number
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- general_
webhook int - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email Number
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- general
Webhook Number - Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone Number
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms Number
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
AlarmsAlarmQueryRequest
- End
Time intOffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- Number int
- Alarm object sequence number; increments from 1.
- Query string
- Query statement, the maximum supported length is 1024.
- Start
Time intOffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- Topic
Id string - The topic id.
- Topic
Name string - The topic name.
- End
Time intOffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- Number int
- Alarm object sequence number; increments from 1.
- Query string
- Query statement, the maximum supported length is 1024.
- Start
Time intOffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- Topic
Id string - The topic id.
- Topic
Name string - The topic name.
- end
Time IntegerOffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number Integer
- Alarm object sequence number; increments from 1.
- query String
- Query statement, the maximum supported length is 1024.
- start
Time IntegerOffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topic
Id String - The topic id.
- topic
Name String - The topic name.
- end
Time numberOffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number number
- Alarm object sequence number; increments from 1.
- query string
- Query statement, the maximum supported length is 1024.
- start
Time numberOffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topic
Id string - The topic id.
- topic
Name string - The topic name.
- end_
time_ intoffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number int
- Alarm object sequence number; increments from 1.
- query str
- Query statement, the maximum supported length is 1024.
- start_
time_ intoffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topic_
id str - The topic id.
- topic_
name str - The topic name.
- end
Time NumberOffset - The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number Number
- Alarm object sequence number; increments from 1.
- query String
- Query statement, the maximum supported length is 1024.
- start
Time NumberOffset - The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topic
Id String - The topic id.
- topic
Name String - The topic name.
AlarmsAlarmRequestCycle
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.