Skip to content

ScalingPlan

Source code in docs_src/capo_auto_scaling_plans/types/scaling_plan.py
class ScalingPlan(TypedDict, closed=True):
    scaling_plan_name: "capo_auto_scaling_plans.types.scaling_plan_name.ScalingPlanName"
    """<p>The name of the scaling plan.</p>"""
    scaling_plan_version: (
        "capo_auto_scaling_plans.types.scaling_plan_version.ScalingPlanVersion"
    )
    """<p>The version number of the scaling plan.</p>"""
    application_source: (
        "capo_auto_scaling_plans.types.application_source.ApplicationSource"
    )
    """<p>A CloudFormation stack or a set of tags. You can create one scaling plan per application source.</p>"""
    scaling_instructions: (
        "capo_auto_scaling_plans.types.scaling_instructions.ScalingInstructions"
    )
    """<p>The scaling instructions.</p>"""
    status_code: (
        "capo_auto_scaling_plans.types.scaling_plan_status_code.ScalingPlanStatusCode"
    )
    """<p>The status of the scaling plan.</p> <ul> <li> <p> <code>Active</code> - The scaling plan is active.</p> </li> <li> <p> <code>ActiveWithProblems</code> - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.</p> </li> <li> <p> <code>CreationInProgress</code> - The scaling plan is being created.</p> </li> <li> <p> <code>CreationFailed</code> - The scaling plan could not be created.</p> </li> <li> <p> <code>DeletionInProgress</code> - The scaling plan is being deleted.</p> </li> <li> <p> <code>DeletionFailed</code> - The scaling plan could not be deleted.</p> </li> <li> <p> <code>UpdateInProgress</code> - The scaling plan is being updated.</p> </li> <li> <p> <code>UpdateFailed</code> - The scaling plan could not be updated.</p> </li> </ul>"""
    status_message: NotRequired["capo_auto_scaling_plans.types.xml_string.XmlString"]
    """<p>A simple message about the current status of the scaling plan.</p>"""
    status_start_time: NotRequired[
        "capo_auto_scaling_plans.types.timestamp_type.TimestampType"
    ]
    """<p>The Unix time stamp when the scaling plan entered the current status.</p>"""
    creation_time: NotRequired[
        "capo_auto_scaling_plans.types.timestamp_type.TimestampType"
    ]
    """<p>The Unix time stamp when the scaling plan was created.</p>"""

application_source instance-attribute

application_source: ApplicationSource

A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

creation_time instance-attribute

creation_time: NotRequired[TimestampType]

The Unix time stamp when the scaling plan was created.

scaling_instructions instance-attribute

scaling_instructions: ScalingInstructions

The scaling instructions.

scaling_plan_name instance-attribute

scaling_plan_name: ScalingPlanName

The name of the scaling plan.

scaling_plan_version instance-attribute

scaling_plan_version: ScalingPlanVersion

The version number of the scaling plan.

status_code instance-attribute

status_code: ScalingPlanStatusCode

The status of the scaling plan.

  • Active - The scaling plan is active.

  • ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

  • CreationInProgress - The scaling plan is being created.

  • CreationFailed - The scaling plan could not be created.

  • DeletionInProgress - The scaling plan is being deleted.

  • DeletionFailed - The scaling plan could not be deleted.

  • UpdateInProgress - The scaling plan is being updated.

  • UpdateFailed - The scaling plan could not be updated.

status_message instance-attribute

status_message: NotRequired[XmlString]

A simple message about the current status of the scaling plan.

status_start_time instance-attribute

status_start_time: NotRequired[TimestampType]

The Unix time stamp when the scaling plan entered the current status.