Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getAlarms

This data source provides available alarm resources.

NOTE Available in 1.72.0+

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const alarmDs = pulumi.output(alicloud.EssAlarm({
    ids: [
        "alarm_id1",
        "alarm_id2",
    ],
    nameRegex: "alarm_name",
    scalingGroupId: "scaling_group_id",
}));

export const firstScalingRule = alicloud_alarms_alarm_ds.configurations.0.id;

Coming soon!

Using getAlarms

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 getAlarms(args: GetAlarmsArgs, opts?: InvokeOptions): Promise<GetAlarmsResult>
function getAlarmsOutput(args: GetAlarmsOutputArgs, opts?: InvokeOptions): Output<GetAlarmsResult>
def get_alarms(ids: Optional[Sequence[str]] = None,
               metric_type: Optional[str] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               scaling_group_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetAlarmsResult
def get_alarms_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               metric_type: Optional[pulumi.Input[str]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               scaling_group_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetAlarmsResult]
func GetAlarms(ctx *Context, args *GetAlarmsArgs, opts ...InvokeOption) (*GetAlarmsResult, error)
func GetAlarmsOutput(ctx *Context, args *GetAlarmsOutputArgs, opts ...InvokeOption) GetAlarmsResultOutput

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

public static class GetAlarms 
{
    public static Task<GetAlarmsResult> InvokeAsync(GetAlarmsArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmsResult> Invoke(GetAlarmsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlarmsResult> getAlarms(GetAlarmsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:ess/getAlarms:getAlarms
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Ids List<string>

A list of alarm IDs.

MetricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

NameRegex string

A regex string to filter resulting alarms by name.

OutputFile string
ScalingGroupId string

Scaling group id the alarms belong to.

Ids []string

A list of alarm IDs.

MetricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

NameRegex string

A regex string to filter resulting alarms by name.

OutputFile string
ScalingGroupId string

Scaling group id the alarms belong to.

ids List<String>

A list of alarm IDs.

metricType String

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

nameRegex String

A regex string to filter resulting alarms by name.

outputFile String
scalingGroupId String

Scaling group id the alarms belong to.

ids string[]

A list of alarm IDs.

metricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

nameRegex string

A regex string to filter resulting alarms by name.

outputFile string
scalingGroupId string

Scaling group id the alarms belong to.

ids Sequence[str]

A list of alarm IDs.

metric_type str

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

name_regex str

A regex string to filter resulting alarms by name.

output_file str
scaling_group_id str

Scaling group id the alarms belong to.

ids List<String>

A list of alarm IDs.

metricType String

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

nameRegex String

A regex string to filter resulting alarms by name.

outputFile String
scalingGroupId String

Scaling group id the alarms belong to.

getAlarms Result

The following output properties are available:

Alarms List<Pulumi.AliCloud.Ess.Outputs.GetAlarmsAlarm>

A list of alarms. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

A list of alarm ids.

Names List<string>

A list of alarm names.

MetricType string

The type for the alarm's associated metric.

NameRegex string
OutputFile string
ScalingGroupId string

The scaling group associated with this alarm.

Alarms []GetAlarmsAlarm

A list of alarms. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids []string

A list of alarm ids.

Names []string

A list of alarm names.

MetricType string

The type for the alarm's associated metric.

NameRegex string
OutputFile string
ScalingGroupId string

The scaling group associated with this alarm.

alarms List<GetAlarmsAlarm>

A list of alarms. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of alarm ids.

names List<String>

A list of alarm names.

metricType String

The type for the alarm's associated metric.

nameRegex String
outputFile String
scalingGroupId String

The scaling group associated with this alarm.

alarms GetAlarmsAlarm[]

A list of alarms. Each element contains the following attributes:

id string

The provider-assigned unique ID for this managed resource.

ids string[]

A list of alarm ids.

names string[]

A list of alarm names.

metricType string

The type for the alarm's associated metric.

nameRegex string
outputFile string
scalingGroupId string

The scaling group associated with this alarm.

alarms Sequence[GetAlarmsAlarm]

A list of alarms. Each element contains the following attributes:

id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

A list of alarm ids.

names Sequence[str]

A list of alarm names.

metric_type str

The type for the alarm's associated metric.

name_regex str
output_file str
scaling_group_id str

The scaling group associated with this alarm.

alarms List<Property Map>

A list of alarms. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of alarm ids.

names List<String>

A list of alarm names.

metricType String

The type for the alarm's associated metric.

nameRegex String
outputFile String
scalingGroupId String

The scaling group associated with this alarm.

Supporting Types

GetAlarmsAlarm

AlarmActions List<string>

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

CloudMonitorGroupId int

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

ComparisonOperator string

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Description string

The description for the alarm.

Dimensions Dictionary<string, object>

The dimension map for the alarm's associated metric.

Enable bool

Whether to enable specific ess alarm.

EvaluationCount int

The number of times that needs to satisfies comparison condition before transition into ALARM state.

Id string

The id of alarm.

MetricName string

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

MetricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

Name string

The name for ess alarm.

Period int

The period in seconds over which the specified statistic is applied.

ScalingGroupId string

Scaling group id the alarms belong to.

State string

The state of alarm task.

Statistics string

The statistic to apply to the alarm's associated metric.

Threshold string

The value against which the specified statistics is compared.

AlarmActions []string

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

CloudMonitorGroupId int

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

ComparisonOperator string

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Description string

The description for the alarm.

Dimensions map[string]interface{}

The dimension map for the alarm's associated metric.

Enable bool

Whether to enable specific ess alarm.

EvaluationCount int

The number of times that needs to satisfies comparison condition before transition into ALARM state.

Id string

The id of alarm.

MetricName string

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

MetricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

Name string

The name for ess alarm.

Period int

The period in seconds over which the specified statistic is applied.

ScalingGroupId string

Scaling group id the alarms belong to.

State string

The state of alarm task.

Statistics string

The statistic to apply to the alarm's associated metric.

Threshold string

The value against which the specified statistics is compared.

alarmActions List<String>

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

cloudMonitorGroupId Integer

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

comparisonOperator String

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

description String

The description for the alarm.

dimensions Map<String,Object>

The dimension map for the alarm's associated metric.

enable Boolean

Whether to enable specific ess alarm.

evaluationCount Integer

The number of times that needs to satisfies comparison condition before transition into ALARM state.

id String

The id of alarm.

metricName String

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

metricType String

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

name String

The name for ess alarm.

period Integer

The period in seconds over which the specified statistic is applied.

scalingGroupId String

Scaling group id the alarms belong to.

state String

The state of alarm task.

statistics String

The statistic to apply to the alarm's associated metric.

threshold String

The value against which the specified statistics is compared.

alarmActions string[]

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

cloudMonitorGroupId number

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

comparisonOperator string

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

description string

The description for the alarm.

dimensions {[key: string]: any}

The dimension map for the alarm's associated metric.

enable boolean

Whether to enable specific ess alarm.

evaluationCount number

The number of times that needs to satisfies comparison condition before transition into ALARM state.

id string

The id of alarm.

metricName string

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

metricType string

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

name string

The name for ess alarm.

period number

The period in seconds over which the specified statistic is applied.

scalingGroupId string

Scaling group id the alarms belong to.

state string

The state of alarm task.

statistics string

The statistic to apply to the alarm's associated metric.

threshold string

The value against which the specified statistics is compared.

alarm_actions Sequence[str]

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

cloud_monitor_group_id int

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

comparison_operator str

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

description str

The description for the alarm.

dimensions Mapping[str, Any]

The dimension map for the alarm's associated metric.

enable bool

Whether to enable specific ess alarm.

evaluation_count int

The number of times that needs to satisfies comparison condition before transition into ALARM state.

id str

The id of alarm.

metric_name str

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

metric_type str

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

name str

The name for ess alarm.

period int

The period in seconds over which the specified statistic is applied.

scaling_group_id str

Scaling group id the alarms belong to.

state str

The state of alarm task.

statistics str

The statistic to apply to the alarm's associated metric.

threshold str

The value against which the specified statistics is compared.

alarmActions List<String>

The list of actions to execute when this alarm transition into an ALARM state. Each action is specified as ess scaling rule ari.

cloudMonitorGroupId Number

Defines the application group id defined by CMS which is assigned when you upload custom metric to CMS, only available for custom metirc.

comparisonOperator String

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

description String

The description for the alarm.

dimensions Map<Any>

The dimension map for the alarm's associated metric.

enable Boolean

Whether to enable specific ess alarm.

evaluationCount Number

The number of times that needs to satisfies comparison condition before transition into ALARM state.

id String

The id of alarm.

metricName String

The name for the alarm's associated metric. See Block_metricNames_and_dimensions below for details.

metricType String

The type for the alarm's associated metric. Supported value: system, custom. "system" means the metric data is collected by Aliyun Cloud Monitor Service(CMS), "custom" means the metric data is upload to CMS by users. Defaults to system.

name String

The name for ess alarm.

period Number

The period in seconds over which the specified statistic is applied.

scalingGroupId String

Scaling group id the alarms belong to.

state String

The state of alarm task.

statistics String

The statistic to apply to the alarm's associated metric.

threshold String

The value against which the specified statistics is compared.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.