AlarmTask

• Implements: IAlarmTask

This class encapsulates and extends the ROS resource type ALIYUN::ESS::AlarmTask.

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
)

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: The list of unique identifiers of the scaling rules that are associated with the event-triggered task.

metric_name^Required

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

Property metricName: The name of the metric.

Valid values of MetricName vary based on the value of MetricType.

• If you set MetricType to custom, the valid values of MetricName are your custom metrics.
• If you set MetricType to system, MetricName has the following valid values:
• CpuUtilization: (ECS) the CPU utilization. Unit: %.
• IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.
• IntranetRx: the inbound traffic over the internal network to an ECS instance. Unit: KB/min.
• VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.
• VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
• SystemDiskReadBps: the number of bytes read from the system disk that is used by an ECS instance per second.
• SystemDiskWriteBps: the number of bytes written to the system disk that is used by an ECS instance per second.
• SystemDiskReadOps: the number of read operations on the system disk that is used by an ECS instance per second.
• SystemDiskWriteOps: the number of write operations on the system disk that is used by an ECS instance per second.
• CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.
• GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.
• GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.
• MemoryUtilization: the memory usage of an agent. Unit: %.
• LoadAverage: the average system load of an agent.
• TcpConnection: the total number of TCP connections of an agent.
• TcpConnection: the number of established TCP connections of an agent.
• PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.
• PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.
• EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.
• EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.

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: The threshold of a metric in the multi-metric alert rule.

If the threshold is reached the specified number of times within the specified period, a scaling rule is executed.

comparison_operator^Optional

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

Property comparisonOperator: The operator that is used to compare the metric value and the metric threshold.

Valid values:

• If the metric value is greater than or equal to the metric threshold, set the value to >=.
• If the metric value is less than or equal to the metric threshold, set the value to <=.
• If the metric value is greater than the metric threshold, set the value to >.
• If the metric value is less than the metric threshold, set the value to <.

description^Optional

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

Property description: The description of the event-triggered task.

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: The number of times that the threshold must be reached before a scaling rule can be executed.

For example, if you set this parameter to 3, the average CPU utilization must reach or exceed 80% three times in a row before a scaling rule is triggered.

group_id^Optional

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

Property groupId: The ID of the application group to which the custom metric belongs.

This parameter must be specified when MetricType is set to custom.

metric_type^Optional

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

Property metricType: The type of the metric.

Valid values:

• system: system metrics of CloudMonitor
• custom: custom metrics that are reported to CloudMonitor

name^Optional

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

Property name: The name of the event-triggered task.

period^Optional

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

Property period: The period of time during which statistics about the metric is collected.

Unit: seconds. Valid values:

• 15
• 60
• 120
• 300
• 900

If your scaling group is of the ECS type and uses CloudMonitor metrics, you can set Period to 15. In other cases, you can set Period to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.

statistics^Optional

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

Property statistics: The method that is used to aggregate statistics for the metric.

Valid values:

• Average
• Minimum
• Maximum

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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: typing.Union[str, IResolvable]

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

Attribute AlarmTaskId: The alarm task ID.

props^Required

props: AlarmTaskProps

• Type: AlarmTaskProps