cms¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.cms.Alarm(resource_name, opts=None, contact_groups=None, dimensions=None, effective_interval=None, enabled=None, end_time=None, metric=None, name=None, operator=None, period=None, project=None, silence_time=None, start_time=None, statistics=None, threshold=None, triggered_count=None, webhook=None, __props__=None, __name__=None, __opts__=None)¶

Create a Alarm resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] contact_groups: List contact groups of the alarm rule, which must have been created on the console. :param pulumi.Input[dict] dimensions: Map of the resources associated with the alarm rule, such as “instanceId”, “device” and “port”. Each key’s value is a string and it uses comma to split multiple items. For more information, see Metrics Reference. :param pulumi.Input[str] effective_interval: The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”. :param pulumi.Input[bool] enabled: Whether to enable alarm rule. Default to true. :param pulumi.Input[float] end_time: It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead. :param pulumi.Input[str] metric: Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkin_rate”. For more information, see Metrics Reference. :param pulumi.Input[str] name: The alarm rule name. :param pulumi.Input[str] operator: Alarm comparison operator. Valid values: [“<=”, “<”, “>”, “>=”, “==”, “!=”]. Default to “==”. :param pulumi.Input[float] period: Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds. :param pulumi.Input[str] project: Monitor project name, such as “acs_ecs_dashboard” and “acs_rds_dashboard”. For more information, see Metrics Reference. :param pulumi.Input[float] silence_time: Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400 :param pulumi.Input[float] start_time: It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead. :param pulumi.Input[str] statistics: Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”. :param pulumi.Input[str] threshold: Alarm threshold value, which must be a numeric value currently. :param pulumi.Input[float] triggered_count: Number of consecutive times it has been detected that the values exceed the threshold. Default to 3. :param pulumi.Input[str] webhook: The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

contact_groups: pulumi.Output[list] = None¶

List contact groups of the alarm rule, which must have been created on the console.

dimensions: pulumi.Output[dict] = None¶

Map of the resources associated with the alarm rule, such as “instanceId”, “device” and “port”. Each key’s value is a string and it uses comma to split multiple items. For more information, see Metrics Reference.

effective_interval: pulumi.Output[str] = None¶

The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”.

enabled: pulumi.Output[bool] = None¶

Whether to enable alarm rule. Default to true.

end_time: pulumi.Output[float] = None¶

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

metric: pulumi.Output[str] = None¶

Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkin_rate”. For more information, see Metrics Reference.

name: pulumi.Output[str] = None¶

The alarm rule name.

operator: pulumi.Output[str] = None¶

Alarm comparison operator. Valid values: [“<=”, “<”, “>”, “>=”, “==”, “!=”]. Default to “==”.

period: pulumi.Output[float] = None¶

Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

project: pulumi.Output[str] = None¶

Monitor project name, such as “acs_ecs_dashboard” and “acs_rds_dashboard”. For more information, see Metrics Reference.

silence_time: pulumi.Output[float] = None¶

Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400

start_time: pulumi.Output[float] = None¶

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

statistics: pulumi.Output[str] = None¶

Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”.

status: pulumi.Output[str] = None¶

The current alarm rule status.

threshold: pulumi.Output[str] = None¶

Alarm threshold value, which must be a numeric value currently.

triggered_count: pulumi.Output[float] = None¶

Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.

webhook: pulumi.Output[str] = None¶

The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

static get(resource_name, id, opts=None, contact_groups=None, dimensions=None, effective_interval=None, enabled=None, end_time=None, metric=None, name=None, operator=None, period=None, project=None, silence_time=None, start_time=None, statistics=None, status=None, threshold=None, triggered_count=None, webhook=None)¶

Get an existing Alarm resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• contact_groups (pulumi.Input[list]) – List contact groups of the alarm rule, which must have been created on the console.

• dimensions (pulumi.Input[dict]) –

  Map of the resources associated with the alarm rule, such as “instanceId”, “device” and “port”. Each key’s value is a string and it uses comma to split multiple items. For more information, see Metrics Reference.

• effective_interval (pulumi.Input[str]) – The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”.

• enabled (pulumi.Input[bool]) – Whether to enable alarm rule. Default to true.

• end_time (pulumi.Input[float]) – It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

• metric (pulumi.Input[str]) –

  Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkin_rate”. For more information, see Metrics Reference.

• name (pulumi.Input[str]) – The alarm rule name.

• operator (pulumi.Input[str]) – Alarm comparison operator. Valid values: [“<=”, “<”, “>”, “>=”, “==”, “!=”]. Default to “==”.

• period (pulumi.Input[float]) – Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

• project (pulumi.Input[str]) –

  Monitor project name, such as “acs_ecs_dashboard” and “acs_rds_dashboard”. For more information, see Metrics Reference.

• silence_time (pulumi.Input[float]) – Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400

• start_time (pulumi.Input[float]) – It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

• statistics (pulumi.Input[str]) – Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”.

• status (pulumi.Input[str]) – The current alarm rule status.

• threshold (pulumi.Input[str]) – Alarm threshold value, which must be a numeric value currently.

• triggered_count (pulumi.Input[float]) – Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.

• webhook (pulumi.Input[str]) – The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.cms.SiteMonitor(resource_name, opts=None, address=None, alert_ids=None, interval=None, isp_cities=None, options_json=None, task_name=None, task_type=None, __props__=None, __name__=None, __opts__=None)¶

This resource provides a site monitor resource and it can be used to monitor public endpoints and websites. Details at https://www.alibabacloud.com/help/doc-detail/67907.htm

Available in 1.72.0+

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• address (pulumi.Input[str]) – The URL or IP address monitored by the site monitoring task.

• alert_ids (pulumi.Input[list]) – The IDs of existing alert rules to be associated with the site monitoring task.

• interval (pulumi.Input[float]) – The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.

• isp_cities (pulumi.Input[list]) – The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.

• options_json (pulumi.Input[str]) – The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

• task_name (pulumi.Input[str]) – The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.

• task_type (pulumi.Input[str]) – The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.

The isp_cities object supports the following:

• city (pulumi.Input[str])

• isp (pulumi.Input[str])

address: pulumi.Output[str] = None¶

The URL or IP address monitored by the site monitoring task.

alert_ids: pulumi.Output[list] = None¶

The IDs of existing alert rules to be associated with the site monitoring task.

interval: pulumi.Output[float] = None¶

The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.

isp_cities: pulumi.Output[list] = None¶

The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.

• city (str)

• isp (str)

options_json: pulumi.Output[str] = None¶

The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

task_name: pulumi.Output[str] = None¶

The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.

task_type: pulumi.Output[str] = None¶

The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.

static get(resource_name, id, opts=None, address=None, alert_ids=None, create_time=None, interval=None, isp_cities=None, options_json=None, task_name=None, task_state=None, task_type=None, update_time=None)¶

Get an existing SiteMonitor resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• address (pulumi.Input[str]) – The URL or IP address monitored by the site monitoring task.

• alert_ids (pulumi.Input[list]) – The IDs of existing alert rules to be associated with the site monitoring task.

• interval (pulumi.Input[float]) – The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.

• isp_cities (pulumi.Input[list]) –

  The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.

• options_json (pulumi.Input[str]) – The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

• task_name (pulumi.Input[str]) – The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.

• task_type (pulumi.Input[str]) – The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.

The isp_cities object supports the following:

• city (pulumi.Input[str])

• isp (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str