Skip to content

CreateRecommendationTemplateRequest

Source code in docs_src/capo_resiliencehub/types/create_recommendation_template_request.py
class CreateRecommendationTemplateRequest(TypedDict, closed=True):
    recommendation_ids: NotRequired[
        "capo_resiliencehub.types.recommendation_id_list.RecommendationIdList"
    ]
    """<p>Identifiers for the recommendations used to create a recommendation template.</p>"""
    format: NotRequired["capo_resiliencehub.types.template_format.TemplateFormat"]
    """<p>The format for 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_types: NotRequired[
        "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>"""
    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>"""
    name: "capo_resiliencehub.types.entity_name.EntityName"
    """<p>The name for the recommendation template.</p>"""
    client_token: NotRequired["capo_resiliencehub.types.client_token.ClientToken"]
    """<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</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>"""
    bucket_name: NotRequired["capo_resiliencehub.types.entity_name.EntityName"]
    """<p>The name of the Amazon S3 bucket that will contain the recommendation template.</p>"""

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.

bucket_name instance-attribute

bucket_name: NotRequired[EntityName]

The name of the Amazon S3 bucket that will contain the recommendation template.

client_token instance-attribute

client_token: NotRequired[ClientToken]

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

format instance-attribute

format: NotRequired[TemplateFormat]

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

name instance-attribute

name: EntityName

The name for the recommendation template.

recommendation_ids instance-attribute

recommendation_ids: NotRequired[RecommendationIdList]

Identifiers for the recommendations used to create a recommendation template.

recommendation_types instance-attribute

recommendation_types: NotRequired[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.

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.