ScalingRules

• Implements: ros_cdk_ess.datasource.IScalingRules

This class encapsulates and extends the ROS resource type DATASOURCE::ESS::ScalingRules, which are used to query the information about scaling rules.

Initializers

from ros_cdk_ess import datasource
datasource.ScalingRules(
  scope: Construct,
  id: str,
  refresh_options: typing.Union[str, IResolvable] = None,
  scaling_group_id: typing.Union[str, IResolvable] = None,
  scaling_rule_aris: typing.Union[typing.List[typing.Any], IResolvable] = None,
  scaling_rule_ids: typing.Union[typing.List[typing.Any], IResolvable] = None,
  scaling_rule_names: typing.Union[typing.List[typing.Any], IResolvable] = None,
  scaling_rule_type: typing.Union[str, IResolvable] = None,
  show_alarm_rules: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

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.

scaling_group_id^Optional

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

Property scalingGroupId: The ID of the scaling group.

scaling_rule_aris^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property scalingRuleAris: The unique identifiers of the scaling rules that you want to query.

scaling_rule_ids^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property scalingRuleIds: The IDs of the scaling rules that you want to query.

scaling_rule_names^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property scalingRuleNames: The names of the scaling rules that you want to query.

scaling_rule_type^Optional

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

Property scalingRuleType: The type of the scaling rule.

Valid values: SimpleScalingRule: adjusts the number of ECS instances based on the values of the AdjustmentType and AdjustmentValue parameters. TargetTrackingScalingRule: calculates the number of ECS instances that need to be scaled in a dynamic manner and maintains the value of a predefined metric close to the value of the TargetValue parameter. StepScalingRule: scales ECS instances in steps based on the specified thresholds and metric values. PredictiveScalingRule: uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling automatically creates scheduled tasks to adjust the boundary values for the scaling group.

show_alarm_rules^Optional

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

Property showAlarmRules: Specifies whether to return the event-triggered tasks that are associated with the scaling rule.

Valid values: true false Default value: false.

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.ScalingRules.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_scaling_rule_ids^Required

attr_scaling_rule_ids: typing.Union[str, IResolvable]

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

Attribute ScalingRuleIds: The list of scaling rule IDs.

attr_scaling_rules^Required

attr_scaling_rules: typing.Union[str, IResolvable]

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

Attribute ScalingRules: The list of scaling rules.

props^Required

props: ScalingRulesProps

• Type: ScalingRulesProps