GetAlarms
This data source provides available alarm resources.
NOTE Available in 1.72.0+
Using GetAlarms
function getAlarms(args: GetAlarmsArgs, opts?: InvokeOptions): Promise<GetAlarmsResult>function get_alarms(ids=None, metric_type=None, name_regex=None, output_file=None, scaling_group_id=None, opts=None)func GetAlarms(ctx *Context, args *GetAlarmsArgs, opts ...InvokeOption) (*GetAlarmsResult, error)public static class GetAlarms {
public static Task<GetAlarmsResult> InvokeAsync(GetAlarmsArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
- Ids List<string>
A list of alarm IDs.
- Metric
Type 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
Regex string A regex string to filter resulting alarms by name.
- Output
File string - Scaling
Group stringId Scaling group id the alarms belong to.
- Ids []string
A list of alarm IDs.
- Metric
Type 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
Regex string A regex string to filter resulting alarms by name.
- Output
File string - Scaling
Group stringId Scaling group id the alarms belong to.
- ids string[]
A list of alarm IDs.
- metric
Type 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
Regex string A regex string to filter resulting alarms by name.
- output
File string - scaling
Group stringId Scaling group id the alarms belong to.
- ids List[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_ strid Scaling group id the alarms belong to.
GetAlarms Result
The following output properties are available:
- Alarms
List<Pulumi.
Ali Cloud. Ess. Outputs. Get Alarms Alarm> 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.
- Metric
Type string The type for the alarm’s associated metric.
- Name
Regex string - Output
File string - Scaling
Group stringId The scaling group associated with this alarm.
- Alarms
[]Get
Alarms Alarm 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.
- Metric
Type string The type for the alarm’s associated metric.
- Name
Regex string - Output
File string - Scaling
Group stringId The scaling group associated with this alarm.
- alarms
Get
Alarms Alarm[] 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.
- metric
Type string The type for the alarm’s associated metric.
- name
Regex string - output
File string - scaling
Group stringId The scaling group associated with this alarm.
- alarms
List[Get
Alarms Alarm] A list of alarms. Each element contains the following attributes:
- id str
The provider-assigned unique ID for this managed resource.
- ids List[str]
A list of alarm ids.
- names List[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_ strid The scaling group associated with this alarm.
Supporting Types
GetAlarmsAlarm
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
- Alarm
Actions 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.
- Cloud
Monitor intGroup Id 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 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.
- Evaluation
Count int The number of times that needs to satisfies comparison condition before transition into ALARM state.
- Id string
The id of alarm.
- Metric
Name string The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.
- Metric
Type 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.
- Scaling
Group stringId 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 []string 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 intGroup Id 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 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.
- Evaluation
Count int The number of times that needs to satisfies comparison condition before transition into ALARM state.
- Id string
The id of alarm.
- Metric
Name string The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.
- Metric
Type 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.
- Scaling
Group stringId 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 string[] 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 numberGroup Id 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 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.
- evaluation
Count number The number of times that needs to satisfies comparison condition before transition into ALARM state.
- id string
The id of alarm.
- metric
Name string The name for the alarm’s associated metric. See Block_metricNames_and_dimensions below for details.
- metric
Type 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.
- scaling
Group stringId 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 List[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_ floatgroup_ id 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 Dict[str, Any]
The dimension map for the alarm’s associated metric.
- enable bool
Whether to enable specific ess alarm.
- evaluation_
count float 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 float
The period in seconds over which the specified statistic is applied.
- scaling_
group_ strid 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.
Package Details
- Repository
- https://github.com/pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.