ScalingRule

• Implements: @alicloud/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 { datasource } from '@alicloud/ros-cdk-ess'
new datasource.ScalingRule(scope: Construct, id: string, props: ScalingRuleProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: ScalingRuleProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-ess'
datasource.ScalingRule.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAdjustmentType^Required

public readonly attrAdjustmentType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AdjustmentType: The adjustment method of the scaling rule.

attrAdjustmentValue^Required

public readonly attrAdjustmentValue: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrAlarms^Required

public readonly attrAlarms: string | IResolvable;

• Type: string | @alicloud/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 readonly attrCooldown: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Cooldown: The cooldown period of the scaling rule.

attrDisableScaleIn^Required

public readonly attrDisableScaleIn: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DisableScaleIn: Indicates whether scale-in is disabled.

attrEstimatedInstanceWarmup^Required

public readonly attrEstimatedInstanceWarmup: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EstimatedInstanceWarmup: The warm-up period of instances.

attrInitialMaxSize^Required

public readonly attrInitialMaxSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrMaxSize^Required

public readonly attrMaxSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrMetricName^Required

public readonly attrMetricName: string | IResolvable;

• Type: string | @alicloud/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 readonly attrMinAdjustmentMagnitude: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrMinSize^Required

public readonly attrMinSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrPredictiveScalingMode^Required

public readonly attrPredictiveScalingMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PredictiveScalingMode: The mode of the predictive scaling rule.

attrPredictiveTaskBufferTime^Required

public readonly attrPredictiveTaskBufferTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrPredictiveValueBehavior^Required

public readonly attrPredictiveValueBehavior: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PredictiveValueBehavior: The action on the predicted maximum value.

attrPredictiveValueBuffer^Required

public readonly attrPredictiveValueBuffer: string | IResolvable;

• Type: string | @alicloud/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 readonly attrScaleInEvaluationCount: string | IResolvable;

• Type: string | @alicloud/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 readonly attrScaleOutEvaluationCount: string | IResolvable;

• Type: string | @alicloud/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 readonly attrScalingGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScalingGroupId: The ID of the scaling group.

attrScalingRuleAri^Required

public readonly attrScalingRuleAri: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScalingRuleAri: The unique identifier of the scaling rule.

attrScalingRuleId^Required

public readonly attrScalingRuleId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScalingRuleId: The ID of the scaling rule.

attrScalingRuleName^Required

public readonly attrScalingRuleName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScalingRuleName: The name of the scaling rule.

attrScalingRuleType^Required

public readonly attrScalingRuleType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ScalingRuleType: The type of the scaling rule.

attrStepAdjustments^Required

public readonly attrStepAdjustments: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrTargetValue^Required

public readonly attrTargetValue: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TargetValue: The target value of the metric.

props^Required

public readonly props: ScalingRuleProps;

• Type: ScalingRuleProps