AlarmTask

This class encapsulates and extends the ROS resource type ALIYUN::ESS::AlarmTask, which is used to create a metric-based alarm task.

Initializers

import ros_cdk_ess
ros_cdk_ess.AlarmTask(
  scope: Construct,
  id: str,
  alarm_action: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  metric_name: typing.Union[str, IResolvable],
  scaling_group_id: typing.Union[str, IResolvable],
  threshold: typing.Union[typing.Union[int, float], IResolvable],
  comparison_operator: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  dimensions: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DimensionsProperty]]] = None,
  evaluation_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  group_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  metric_type: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  statistics: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
alarm_action	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property alarmAction: Alarm Actions.
metric_name	typing.Union[str, ros_cdk_core.IResolvable]	Property metricName: Metric Name.
scaling_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property scalingGroupId: The ID of the scaling group.
threshold	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property threshold: Threshold.
comparison_operator	typing.Union[str, ros_cdk_core.IResolvable]	Property comparisonOperator: Comparison Operator.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: Description.
dimensions	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DimensionsProperty]]]	Property dimensions: Dimensions.
evaluation_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property evaluationCount: Evaluation Count.
group_id	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property groupId: Group Id.
metric_type	typing.Union[str, ros_cdk_core.IResolvable]	Property metricType: Metric Type.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: Name.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property period: Period.
statistics	typing.Union[str, ros_cdk_core.IResolvable]	Property statistics: Statistics.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

alarm_action^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property alarmAction: Alarm Actions.

---

metric_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property metricName: Metric Name.

---

scaling_group_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property scalingGroupId: The ID of the scaling group.

---

threshold^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property threshold: Threshold.

---

comparison_operator^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property comparisonOperator: Comparison Operator.

---

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Description.

---

dimensions^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DimensionsProperty]]]

Property dimensions: Dimensions.

---

evaluation_count^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property evaluationCount: Evaluation Count.

---

group_id^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property groupId: Group Id.

---

metric_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property metricType: Metric Type.

---

name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: Name.

---

period^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property period: Period.

---

statistics^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property statistics: Statistics.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ess
ros_cdk_ess.AlarmTask.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_alarm_task_id	ros_cdk_core.IResolvable	Attribute AlarmTaskId: The alarm task ID.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_alarm_task_id^Required

attr_alarm_task_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AlarmTaskId: The alarm task ID.

---