Class Alarm

Inheritance

System.Object

Resource

CustomResource

Alarm

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.Ess

Assembly: Pulumi.AliCloud.dll

Syntax

public class Alarm : CustomResource

Constructors

View Source

Alarm(String, AlarmArgs, CustomResourceOptions)

Create a Alarm resource with the given unique name, arguments, and options.

Declaration

public Alarm(string name, AlarmArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AlarmArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AlarmActions

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

Declaration

public Output<ImmutableArray<string>> AlarmActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

CloudMonitorGroupId

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

Declaration

public Output<int?> CloudMonitorGroupId { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

ComparisonOperator

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Supported value: >=, <=, >, <. Defaults to >=.

Declaration

public Output<string> ComparisonOperator { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

The description for the alarm.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

Dimensions

The dimension map for the alarm's associated metric (documented below). For all metrics, you can not set the dimension key as "scaling_group" or "userId", which is set by default, the second dimension for metric, such as "device" for "PackagesNetIn", need to be set by users.

Declaration

public Output<ImmutableDictionary<string, object>> Dimensions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

Enable

Whether to enable specific ess alarm. Default to true.

Declaration

public Output<bool?> Enable { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

EvaluationCount

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

Declaration

public Output<int?> EvaluationCount { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

MetricName

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

Declaration

public Output<string> MetricName { get; }

Property Value

Type	Description
Output<System.String>

View Source

MetricType

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.

Declaration

public Output<string> MetricType { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

The name for ess alarm.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

Period

The period in seconds over which the specified statistic is applied. Supported value: 60, 120, 300, 900. Defaults to 300.

Declaration

public Output<int?> Period { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

ScalingGroupId

The scaling group associated with this alarm, the 'ForceNew' attribute is available in 1.56.0+.

Declaration

public Output<string> ScalingGroupId { get; }

Property Value

Type	Description
Output<System.String>

View Source

State

The state of specified alarm.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

View Source

Statistics

The statistic to apply to the alarm's associated metric. Supported value: Average, Minimum, Maximum. Defaults to Average.

Declaration

public Output<string> Statistics { get; }

Property Value

Type	Description
Output<System.String>

View Source

Threshold

The value against which the specified statistics is compared.

Declaration

public Output<string> Threshold { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, AlarmState, CustomResourceOptions)

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

Declaration

public static Alarm Get(string name, Input<string> id, AlarmState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AlarmState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Alarm