1. Packages
  2. Coralogix Provider
  3. API Docs
  4. getAlertsScheduler
Viewing docs for coralogix 2.0.20
published on Tuesday, May 20, 2025 by coralogix
Schema (JSON)
coralogix/terraform-provider-coralogix

coralogix.getAlertsScheduler

coralogix logo
Viewing docs for coralogix 2.0.20
published on Tuesday, May 20, 2025 by coralogix
Schema (JSON)
coralogix/terraform-provider-coralogix

    Coralogix alerts-scheduler.

    Using getAlertsScheduler

    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 getAlertsScheduler(args: GetAlertsSchedulerArgs, opts?: InvokeOptions): Promise<GetAlertsSchedulerResult>
function getAlertsSchedulerOutput(args: GetAlertsSchedulerOutputArgs, opts?: InvokeOptions): Output<GetAlertsSchedulerResult>
    def get_alerts_scheduler(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAlertsSchedulerResult
def get_alerts_scheduler_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAlertsSchedulerResult]
    func LookupAlertsScheduler(ctx *Context, args *LookupAlertsSchedulerArgs, opts ...InvokeOption) (*LookupAlertsSchedulerResult, error)
func LookupAlertsSchedulerOutput(ctx *Context, args *LookupAlertsSchedulerOutputArgs, opts ...InvokeOption) LookupAlertsSchedulerResultOutput

    > Note: This function is named LookupAlertsScheduler in the Go SDK.

    public static class GetAlertsScheduler 
{
    public static Task<GetAlertsSchedulerResult> InvokeAsync(GetAlertsSchedulerArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertsSchedulerResult> Invoke(GetAlertsSchedulerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAlertsSchedulerResult> getAlertsScheduler(GetAlertsSchedulerArgs args, InvokeOptions options)
public static Output<GetAlertsSchedulerResult> getAlertsScheduler(GetAlertsSchedulerArgs args, InvokeOptions options)

    fn::invoke:
  function: coralogix:index/getAlertsScheduler:getAlertsScheduler
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Alert Scheduler ID.
    Id string
    Alert Scheduler ID.
    id String
    Alert Scheduler ID.
    id string
    Alert Scheduler ID.
    id str
    Alert Scheduler ID.
    id String
    Alert Scheduler ID.

    getAlertsScheduler Result

    The following output properties are available:

    Description string
    Alert Scheduler description.
    Enabled bool
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    Filter GetAlertsSchedulerFilter
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    Id string
    Alert Scheduler ID.
    MetaLabels List<GetAlertsSchedulerMetaLabel>
    Alert Scheduler meta labels.
    Name string
    Alert Scheduler name.
    Schedule GetAlertsSchedulerSchedule
    Exactly one of one_time or recurring must be set.
    Description string
    Alert Scheduler description.
    Enabled bool
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    Filter GetAlertsSchedulerFilter
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    Id string
    Alert Scheduler ID.
    MetaLabels []GetAlertsSchedulerMetaLabel
    Alert Scheduler meta labels.
    Name string
    Alert Scheduler name.
    Schedule GetAlertsSchedulerSchedule
    Exactly one of one_time or recurring must be set.
    description String
    Alert Scheduler description.
    enabled Boolean
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    filter GetAlertsSchedulerFilter
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    id String
    Alert Scheduler ID.
    metaLabels List<GetAlertsSchedulerMetaLabel>
    Alert Scheduler meta labels.
    name String
    Alert Scheduler name.
    schedule GetAlertsSchedulerSchedule
    Exactly one of one_time or recurring must be set.
    description string
    Alert Scheduler description.
    enabled boolean
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    filter GetAlertsSchedulerFilter
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    id string
    Alert Scheduler ID.
    metaLabels GetAlertsSchedulerMetaLabel[]
    Alert Scheduler meta labels.
    name string
    Alert Scheduler name.
    schedule GetAlertsSchedulerSchedule
    Exactly one of one_time or recurring must be set.
    description str
    Alert Scheduler description.
    enabled bool
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    filter GetAlertsSchedulerFilter
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    id str
    Alert Scheduler ID.
    meta_labels Sequence[GetAlertsSchedulerMetaLabel]
    Alert Scheduler meta labels.
    name str
    Alert Scheduler name.
    schedule GetAlertsSchedulerSchedule
    Exactly one of one_time or recurring must be set.
    description String
    Alert Scheduler description.
    enabled Boolean
    Alert Scheduler enabled. If set to false, the alert scheduler will be disabled. True by default.
    filter Property Map
    Alert Scheduler filter. Only one of meta_labels or alerts_unique_ids can be set. If none of them set, all alerts will be affected.
    id String
    Alert Scheduler ID.
    metaLabels List<Property Map>
    Alert Scheduler meta labels.
    name String
    Alert Scheduler name.
    schedule Property Map
    Exactly one of one_time or recurring must be set.

    Supporting Types

    GetAlertsSchedulerFilter

    GetAlertsSchedulerFilterMetaLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetAlertsSchedulerMetaLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetAlertsSchedulerSchedule

    oneTime Property Map
    operation String
    The operation to perform. Can be mute or active.
    recurring Property Map

    GetAlertsSchedulerScheduleOneTime

    GetAlertsSchedulerScheduleOneTimeTimeFrame

    Duration GetAlertsSchedulerScheduleOneTimeTimeFrameDuration
    The duration from the start time to wait.
    EndTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    StartTime string
    TimeZone string
    Duration GetAlertsSchedulerScheduleOneTimeTimeFrameDuration
    The duration from the start time to wait.
    EndTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    StartTime string
    TimeZone string
    duration GetAlertsSchedulerScheduleOneTimeTimeFrameDuration
    The duration from the start time to wait.
    endTime String
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime String
    timeZone String
    duration GetAlertsSchedulerScheduleOneTimeTimeFrameDuration
    The duration from the start time to wait.
    endTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime string
    timeZone string
    duration GetAlertsSchedulerScheduleOneTimeTimeFrameDuration
    The duration from the start time to wait.
    end_time str
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    start_time str
    time_zone str
    duration Property Map
    The duration from the start time to wait.
    endTime String
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime String
    timeZone String

    GetAlertsSchedulerScheduleOneTimeTimeFrameDuration

    ForOver double
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    Frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    ForOver float64
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    Frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver Double
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency String
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver number
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    for_over float
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency str
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver Number
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency String
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.

    GetAlertsSchedulerScheduleRecurring

    GetAlertsSchedulerScheduleRecurringDynamic

    GetAlertsSchedulerScheduleRecurringDynamicFrequency

    GetAlertsSchedulerScheduleRecurringDynamicFrequencyMonthly

    Days List<double>
    Days []float64
    days List<Double>
    days number[]
    days Sequence[float]
    days List<Number>

    GetAlertsSchedulerScheduleRecurringDynamicFrequencyWeekly

    Days List<string>
    Days []string
    days List<String>
    days string[]
    days Sequence[str]
    days List<String>

    GetAlertsSchedulerScheduleRecurringDynamicTimeFrame

    Duration GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration
    The duration from the start time to wait.
    EndTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    StartTime string
    TimeZone string
    Duration GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration
    The duration from the start time to wait.
    EndTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    StartTime string
    TimeZone string
    duration GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration
    The duration from the start time to wait.
    endTime String
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime String
    timeZone String
    duration GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration
    The duration from the start time to wait.
    endTime string
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime string
    timeZone string
    duration GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration
    The duration from the start time to wait.
    end_time str
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    start_time str
    time_zone str
    duration Property Map
    The duration from the start time to wait.
    endTime String
    The end time of the time frame. In a isodate format. For example, 2021-01-01T00:00:00.000.
    startTime String
    timeZone String

    GetAlertsSchedulerScheduleRecurringDynamicTimeFrameDuration

    ForOver double
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    Frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    ForOver float64
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    Frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver Double
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency String
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver number
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency string
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    for_over float
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency str
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.
    forOver Number
    The number of time units to wait before the alert is triggered. For example, if the frequency is set to hours and the value is set to 2, the alert will be triggered after 2 hours.
    frequency String
    The time unit to wait before the alert is triggered. Can be minutes, hours or days.

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    Viewing docs for coralogix 2.0.20
    published on Tuesday, May 20, 2025 by coralogix
    Schema (JSON)
    coralogix/terraform-provider-coralogix
      Try Pulumi Cloud free. Your team will thank you.