Skip to content

AlarmRecommendation

Source code in docs_src/capo_resiliencehub/types/alarm_recommendation.py
class AlarmRecommendation(TypedDict, closed=True):
    recommendation_id: "capo_resiliencehub.types.uuid.Uuid"
    """<p>Identifier of the alarm recommendation.</p>"""
    reference_id: "capo_resiliencehub.types.spec_reference_id.SpecReferenceId"
    """<p>Reference identifier of the alarm recommendation.</p>"""
    name: "capo_resiliencehub.types.string500.String500"
    """<p>Name of the alarm recommendation.</p>"""
    description: NotRequired[
        "capo_resiliencehub.types.entity_description.EntityDescription"
    ]
    """<p>Description of the alarm recommendation.</p>"""
    type: "capo_resiliencehub.types.alarm_type.AlarmType"
    """<p>Type of alarm recommendation.</p>"""
    app_component_name: NotRequired["capo_resiliencehub.types.entity_id.EntityId"]
    """<p>Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the <code>appComponentNames</code> list.</p>"""
    items: NotRequired[
        "capo_resiliencehub.types.recommendation_item_list.RecommendationItemList"
    ]
    """<p>List of CloudWatch alarm recommendations.</p>"""
    prerequisite: NotRequired["capo_resiliencehub.types.string500.String500"]
    """<p>The prerequisite for the alarm recommendation.</p>"""
    app_component_names: NotRequired[
        "capo_resiliencehub.types.app_component_name_list.AppComponentNameList"
    ]
    """<p>List of Application Component names for the CloudWatch alarm recommendation.</p>"""
    recommendation_status: NotRequired[
        "capo_resiliencehub.types.recommendation_status.RecommendationStatus"
    ]
    """<p>Status of the recommended Amazon CloudWatch alarm.</p>"""

app_component_name instance-attribute

app_component_name: NotRequired[EntityId]

Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

app_component_names instance-attribute

app_component_names: NotRequired[AppComponentNameList]

List of Application Component names for the CloudWatch alarm recommendation.

description instance-attribute

description: NotRequired[EntityDescription]

Description of the alarm recommendation.

items instance-attribute

items: NotRequired[RecommendationItemList]

List of CloudWatch alarm recommendations.

name instance-attribute

name: String500

Name of the alarm recommendation.

prerequisite instance-attribute

prerequisite: NotRequired[String500]

The prerequisite for the alarm recommendation.

recommendation_id instance-attribute

recommendation_id: Uuid

Identifier of the alarm recommendation.

recommendation_status instance-attribute

recommendation_status: NotRequired[RecommendationStatus]

Status of the recommended Amazon CloudWatch alarm.

reference_id instance-attribute

reference_id: SpecReferenceId

Reference identifier of the alarm recommendation.

type instance-attribute

type: AlarmType

Type of alarm recommendation.