Skip to content

AutoScalingConfiguration

Source code in docs_src/capo_finspace/types/auto_scaling_configuration.py
class AutoScalingConfiguration(TypedDict, closed=True):
    min_node_count: NotRequired["capo_finspace.types.node_count.NodeCount"]
    """<p>The lowest number of nodes to scale. This value must be at least 1 and less than the <code>maxNodeCount</code>. If the nodes in a cluster belong to multiple availability zones, then <code>minNodeCount</code> must be at least 3.</p>"""
    max_node_count: NotRequired["capo_finspace.types.node_count.NodeCount"]
    """<p>The highest number of nodes to scale. This value cannot be greater than 5.</p>"""
    auto_scaling_metric: NotRequired[
        "capo_finspace.types.auto_scaling_metric.AutoScalingMetric"
    ]
    """<p> The metric your cluster will track in order to scale in and out. For example, <code>CPU_UTILIZATION_PERCENTAGE</code> is the average CPU usage across all the nodes in a cluster.</p>"""
    metric_target: NotRequired[
        "capo_finspace.types.auto_scaling_metric_target.AutoScalingMetricTarget"
    ]
    """<p>The desired value of the chosen <code>autoScalingMetric</code>. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.</p>"""
    scale_in_cooldown_seconds: NotRequired[
        "capo_finspace.types.cooldown_time.CooldownTime"
    ]
    """<p>The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.</p>"""
    scale_out_cooldown_seconds: NotRequired[
        "capo_finspace.types.cooldown_time.CooldownTime"
    ]
    """<p>The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.</p>"""

auto_scaling_metric instance-attribute

auto_scaling_metric: NotRequired[AutoScalingMetric]

The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

max_node_count instance-attribute

max_node_count: NotRequired[NodeCount]

The highest number of nodes to scale. This value cannot be greater than 5.

metric_target instance-attribute

metric_target: NotRequired[AutoScalingMetricTarget]

The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

min_node_count instance-attribute

min_node_count: NotRequired[NodeCount]

The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

scale_in_cooldown_seconds instance-attribute

scale_in_cooldown_seconds: NotRequired[CooldownTime]

The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

scale_out_cooldown_seconds instance-attribute

scale_out_cooldown_seconds: NotRequired[CooldownTime]

The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.