ScalingRule

• Implements: 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

from ros_cdk_ess import datasource
datasource.ScalingRule(
  scope: Construct,
  id: str,
  scaling_rule_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

scaling_rule_id^Required

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

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

refresh_options^Optional

• Type: typing.Union[str, 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.

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

from ros_cdk_ess import datasource
datasource.ScalingRule.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_adjustment_type^Required

attr_adjustment_type: typing.Union[str, IResolvable]

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

Attribute AdjustmentType: The adjustment method of the scaling rule.

attr_adjustment_value^Required

attr_adjustment_value: typing.Union[str, IResolvable]

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

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

attr_alarms^Required

attr_alarms: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_cooldown^Required

attr_cooldown: typing.Union[str, IResolvable]

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

Attribute Cooldown: The cooldown period of the scaling rule.

attr_disable_scale_in^Required

attr_disable_scale_in: typing.Union[str, IResolvable]

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

Attribute DisableScaleIn: Indicates whether scale-in is disabled.

attr_estimated_instance_warmup^Required

attr_estimated_instance_warmup: typing.Union[str, IResolvable]

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

Attribute EstimatedInstanceWarmup: The warm-up period of instances.

attr_initial_max_size^Required

attr_initial_max_size: typing.Union[str, IResolvable]

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

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

attr_max_size^Required

attr_max_size: typing.Union[str, IResolvable]

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

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

attr_metric_name^Required

attr_metric_name: typing.Union[str, IResolvable]

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

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

attr_min_adjustment_magnitude^Required

attr_min_adjustment_magnitude: typing.Union[str, IResolvable]

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

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

attr_min_size^Required

attr_min_size: typing.Union[str, IResolvable]

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

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

attr_predictive_scaling_mode^Required

attr_predictive_scaling_mode: typing.Union[str, IResolvable]

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

Attribute PredictiveScalingMode: The mode of the predictive scaling rule.

attr_predictive_task_buffer_time^Required

attr_predictive_task_buffer_time: typing.Union[str, IResolvable]

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

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

attr_predictive_value_behavior^Required

attr_predictive_value_behavior: typing.Union[str, IResolvable]

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

Attribute PredictiveValueBehavior: The action on the predicted maximum value.

attr_predictive_value_buffer^Required

attr_predictive_value_buffer: typing.Union[str, IResolvable]

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

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

attr_scale_in_evaluation_count^Required

attr_scale_in_evaluation_count: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_scale_out_evaluation_count^Required

attr_scale_out_evaluation_count: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_scaling_group_id^Required

attr_scaling_group_id: typing.Union[str, IResolvable]

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

Attribute ScalingGroupId: The ID of the scaling group.

attr_scaling_rule_ari^Required

attr_scaling_rule_ari: typing.Union[str, IResolvable]

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

Attribute ScalingRuleAri: The unique identifier of the scaling rule.

attr_scaling_rule_id^Required

attr_scaling_rule_id: typing.Union[str, IResolvable]

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

Attribute ScalingRuleId: The ID of the scaling rule.

attr_scaling_rule_name^Required

attr_scaling_rule_name: typing.Union[str, IResolvable]

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

Attribute ScalingRuleName: The name of the scaling rule.

attr_scaling_rule_type^Required

attr_scaling_rule_type: typing.Union[str, IResolvable]

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

Attribute ScalingRuleType: The type of the scaling rule.

attr_step_adjustments^Required

attr_step_adjustments: typing.Union[str, IResolvable]

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

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

attr_target_value^Required

attr_target_value: typing.Union[str, IResolvable]

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

Attribute TargetValue: The target value of the metric.

props^Required

props: ScalingRuleProps

• Type: ScalingRuleProps