ScalingRule

• Implements: com.aliyun.ros.cdk.ess.datasource.IScalingRule

This class encapsulates and extends the ROS resource type DATASOURCE::ESS::ScalingRule, which is used to query the information about a scaling rule.

Initializers

import com.aliyun.ros.cdk.ess.datasource.ScalingRule;
ScalingRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .scalingRuleId(java.lang.String)
    .scalingRuleId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

scalingRuleId^Required

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

Property scalingRuleId: The ID of the scaling rule that you want to query.

refreshOptions^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.datasource.ScalingRule;
ScalingRule.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

attrAdjustmentType^Required

public java.lang.Object getAttrAdjustmentType();

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

Attribute AdjustmentType: The adjustment method of the scaling rule.

attrAdjustmentValue^Required

public java.lang.Object getAttrAdjustmentValue();

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

Attribute AdjustmentValue: The number of instances that must be scaled based on the scaling rule.

attrAlarms^Required

public java.lang.Object getAttrAlarms();

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

Attribute Alarms: The event-triggered tasks that are associated with the scaling rule.

The value of this parameter is returned only if you set ShowAlarmRules to true. Otherwise, null is returned.

attrCooldown^Required

public java.lang.Object getAttrCooldown();

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

Attribute Cooldown: The cooldown period of the scaling rule.

attrDisableScaleIn^Required

public java.lang.Object getAttrDisableScaleIn();

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

Attribute DisableScaleIn: Indicates whether scale-in is disabled.

attrEstimatedInstanceWarmup^Required

public java.lang.Object getAttrEstimatedInstanceWarmup();

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

Attribute EstimatedInstanceWarmup: The warm-up period of instances.

attrInitialMaxSize^Required

public java.lang.Object getAttrInitialMaxSize();

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

Attribute InitialMaxSize: The maximum number of ECS instances that can be contained in the scaling group.

attrMaxSize^Required

public java.lang.Object getAttrMaxSize();

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

Attribute MaxSize: The maximum number of ECS instances that can be contained in the scaling group.

attrMetricName^Required

public java.lang.Object getAttrMetricName();

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

Attribute MetricName: The name of the metric of the event-triggered task that is associated with the scaling rule.

attrMinAdjustmentMagnitude^Required

public java.lang.Object getAttrMinAdjustmentMagnitude();

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

Attribute MinAdjustmentMagnitude: The minimum number of instances that must be scaled.

attrMinSize^Required

public java.lang.Object getAttrMinSize();

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

Attribute MinSize: The minimum number of ECS instances that must be contained in the scaling group.

attrPredictiveScalingMode^Required

public java.lang.Object getAttrPredictiveScalingMode();

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

Attribute PredictiveScalingMode: The mode of the predictive scaling rule.

attrPredictiveTaskBufferTime^Required

public java.lang.Object getAttrPredictiveTaskBufferTime();

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

Attribute PredictiveTaskBufferTime: The amount of buffer time before prediction tasks are executed.

attrPredictiveValueBehavior^Required

public java.lang.Object getAttrPredictiveValueBehavior();

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

Attribute PredictiveValueBehavior: The action on the predicted maximum value.

attrPredictiveValueBuffer^Required

public java.lang.Object getAttrPredictiveValueBuffer();

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

Attribute PredictiveValueBuffer: The ratio based on which the predicted value is increased when PredictiveValueBehavior is set to PredictiveValueOverrideMaxWithBuffer.

attrScaleInEvaluationCount^Required

public java.lang.Object getAttrScaleInEvaluationCount();

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

Attribute ScaleInEvaluationCount: The number of consecutive times that the event-triggered task for scale-in purposes must meet the threshold conditions before an alert is triggered.

attrScaleOutEvaluationCount^Required

public java.lang.Object getAttrScaleOutEvaluationCount();

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

Attribute ScaleOutEvaluationCount: The number of consecutive times that the event-triggered task created for scale-out purposes must meet the threshold conditions before an alert is triggered.

attrScalingGroupId^Required

public java.lang.Object getAttrScalingGroupId();

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

Attribute ScalingGroupId: The ID of the scaling group.

attrScalingRuleAri^Required

public java.lang.Object getAttrScalingRuleAri();

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

Attribute ScalingRuleAri: The unique identifier of the scaling rule.

attrScalingRuleId^Required

public java.lang.Object getAttrScalingRuleId();

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

Attribute ScalingRuleId: The ID of the scaling rule.

attrScalingRuleName^Required

public java.lang.Object getAttrScalingRuleName();

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

Attribute ScalingRuleName: The name of the scaling rule.

attrScalingRuleType^Required

public java.lang.Object getAttrScalingRuleType();

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

Attribute ScalingRuleType: The type of the scaling rule.

attrStepAdjustments^Required

public java.lang.Object getAttrStepAdjustments();

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

Attribute StepAdjustments: The step adjustments of the step scaling rule.

attrTargetValue^Required

public java.lang.Object getAttrTargetValue();

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

Attribute TargetValue: The target value of the metric.

props^Required

public ScalingRuleProps getProps();

• Type: ScalingRuleProps