AlarmTask

• Implements: IAlarmTask

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

Initializers

import com.aliyun.ros.cdk.ess.AlarmTask;
AlarmTask.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .alarmAction(IResolvable)
    .alarmAction(java.util.List<java.lang.String)
    .alarmAction(IResolvable>)
    .metricName(java.lang.String)
    .metricName(IResolvable)
    .scalingGroupId(java.lang.String)
    .scalingGroupId(IResolvable)
    .threshold(java.lang.Number)
    .threshold(IResolvable)
//  .comparisonOperator(java.lang.String)
//  .comparisonOperator(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .dimensions(IResolvable)
//  .dimensions(java.util.List<IResolvable)
//  .dimensions(DimensionsProperty>)
//  .evaluationCount(java.lang.Number)
//  .evaluationCount(IResolvable)
//  .groupId(java.lang.Number)
//  .groupId(IResolvable)
//  .metricType(java.lang.String)
//  .metricType(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .statistics(java.lang.String)
//  .statistics(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

alarmAction^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property alarmAction: The list of unique identifiers of the scaling rules that are associated with the event-triggered task.

metricName^Required

• Type: java.lang.String OR com.aliyun.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: %.

scalingGroupId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scalingGroupId: The ID of the scaling group.

threshold^Required

• Type: java.lang.Number OR com.aliyun.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.

comparisonOperator^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dimensions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDimensionsProperty>

Property dimensions: Dimensions.

evaluationCount^Optional

• Type: java.lang.Number OR com.aliyun.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.

groupId^Optional

• Type: java.lang.Number OR com.aliyun.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.

metricType^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

period^Optional

• Type: java.lang.Number OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

• Average
• Minimum
• Maximum

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ess.AlarmTask;
AlarmTask.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAlarmTaskId^Required

public java.lang.Object getAttrAlarmTaskId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AlarmTaskId: The alarm task ID.

props^Required

public AlarmTaskProps getProps();

• Type: AlarmTaskProps