Skip to content

RecommendationTemplate

Source code in docs_src/capo_resiliencehub/types/recommendation_template.py
class RecommendationTemplate(TypedDict, closed=True):
    templates_location: NotRequired["capo_resiliencehub.types.s3_location.S3Location"]
    """<p>The file location of the template.</p>"""
    assessment_arn: "capo_resiliencehub.types.arn.Arn"
    """<p>Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""
    app_arn: NotRequired["capo_resiliencehub.types.arn.Arn"]
    """<p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""
    recommendation_ids: NotRequired[
        "capo_resiliencehub.types.recommendation_id_list.RecommendationIdList"
    ]
    """<p>Identifiers for the recommendations used in the recommendation template.</p>"""
    recommendation_types: "capo_resiliencehub.types.render_recommendation_type_list.RenderRecommendationTypeList"
    """<p>An array of strings that specify the recommendation template type or types.</p> <dl> <dt>Alarm</dt> <dd> <p>The template is an <a>AlarmRecommendation</a> template.</p> </dd> <dt>Sop</dt> <dd> <p>The template is a <a>SopRecommendation</a> template.</p> </dd> <dt>Test</dt> <dd> <p>The template is a <a>TestRecommendation</a> template.</p> </dd> </dl>"""
    format: "capo_resiliencehub.types.template_format.TemplateFormat"
    """<p>Format of the recommendation template.</p> <dl> <dt>CfnJson</dt> <dd> <p>The template is CloudFormation JSON.</p> </dd> <dt>CfnYaml</dt> <dd> <p>The template is CloudFormation YAML.</p> </dd> </dl>"""
    recommendation_template_arn: "capo_resiliencehub.types.arn.Arn"
    """<p>Amazon Resource Name (ARN) for the recommendation template.</p>"""
    message: NotRequired["capo_resiliencehub.types.string500.String500"]
    """<p>Message for the recommendation template.</p>"""
    status: "capo_resiliencehub.types.recommendation_template_status.RecommendationTemplateStatus"
    """<p>Status of the action.</p>"""
    name: "capo_resiliencehub.types.entity_name.EntityName"
    """<p>Name for the recommendation template.</p>"""
    start_time: NotRequired["capo_resiliencehub.types.time_stamp.TimeStamp"]
    """<p>The start time for the action.</p>"""
    end_time: NotRequired["capo_resiliencehub.types.time_stamp.TimeStamp"]
    """<p>The end time for the action.</p>"""
    tags: NotRequired["capo_resiliencehub.types.tag_map.TagMap"]
    """<p>Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"""
    needs_replacements: NotRequired[
        "capo_resiliencehub.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates if replacements are needed.</p>"""

app_arn instance-attribute

app_arn: NotRequired[Arn]

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

assessment_arn instance-attribute

assessment_arn: Arn

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

end_time instance-attribute

end_time: NotRequired[TimeStamp]

The end time for the action.

format instance-attribute

Format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

message instance-attribute

message: NotRequired[String500]

Message for the recommendation template.

name instance-attribute

name: EntityName

Name for the recommendation template.

needs_replacements instance-attribute

needs_replacements: NotRequired[BooleanOptional]

Indicates if replacements are needed.

recommendation_ids instance-attribute

recommendation_ids: NotRequired[RecommendationIdList]

Identifiers for the recommendations used in the recommendation template.

recommendation_template_arn instance-attribute

recommendation_template_arn: Arn

Amazon Resource Name (ARN) for the recommendation template.

recommendation_types instance-attribute

recommendation_types: RenderRecommendationTypeList

An array of strings that specify the recommendation template type or types.

Alarm

The template is an AlarmRecommendation template.

Sop

The template is a SopRecommendation template.

Test

The template is a TestRecommendation template.

start_time instance-attribute

start_time: NotRequired[TimeStamp]

The start time for the action.

status instance-attribute

Status of the action.

tags instance-attribute

tags: NotRequired[TagMap]

Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

templates_location instance-attribute

templates_location: NotRequired[S3Location]

The file location of the template.