Skip to content

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 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
alarmAction com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property alarmAction: Alarm Actions.
metricName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property metricName: Metric Name.
scalingGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scalingGroupId: The ID of the scaling group.
threshold java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property threshold: Threshold.
comparisonOperator java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property comparisonOperator: Comparison Operator.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description.
dimensions com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDimensionsProperty> Property dimensions: Dimensions.
evaluationCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property evaluationCount: Evaluation Count.
groupId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property groupId: Group Id.
metricType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property metricType: Metric Type.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: Name.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Period.
statistics java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property statistics: Statistics.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

alarmActionRequired

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

Property alarmAction: Alarm Actions.

metricNameRequired

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

Property metricName: Metric Name.

scalingGroupIdRequired

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

Property scalingGroupId: The ID of the scaling group.

thresholdRequired

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

Property threshold: Threshold.

comparisonOperatorOptional

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

Property comparisonOperator: Comparison Operator.

descriptionOptional

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

Property description: Description.

dimensionsOptional

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

Property dimensions: Dimensions.

evaluationCountOptional

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

Property evaluationCount: Evaluation Count.

groupIdOptional

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

Property groupId: Group Id.

metricTypeOptional

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

Property metricType: Metric Type.

nameOptional

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

Property name: Name.

periodOptional

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

Property period: Period.

statisticsOptional

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

Property statistics: Statistics.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAlarmTaskId com.aliyun.ros.cdk.core.IResolvable Attribute AlarmTaskId: The alarm task ID.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAlarmTaskIdRequired 

public IResolvable getAttrAlarmTaskId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AlarmTaskId: The alarm task ID.