View a markdown version of this page

AWS::ResilienceHub::RecommendationTemplate - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ResilienceHub::RecommendationTemplate

Defines a recommendation template created with the CreateRecommendationTemplate action.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ResilienceHub::RecommendationTemplate",
  "Properties" : {
      "AssessmentArn" : String,
      "Format" : String,
      "Name" : String,
      "RecommendationTypes" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ResilienceHub::RecommendationTemplate
Properties:
  AssessmentArn: String
  Format: String
  Name: String
  RecommendationTypes: 
    - String
  Tags: 
    - Tag

Properties

AssessmentArn

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 General Reference guide.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$

Update requires: Replacement

Format

Format of the recommendation template.

CfnJson

The template is Amazon CloudFormation JSON.

CfnYaml

The template is Amazon CloudFormation YAML.

Required: Yes

Type: String

Allowed values: CfnYaml | CfnJson

Update requires: Replacement

Name

Name for the recommendation template.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Update requires: Replacement

RecommendationTypes

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.

Required: Yes

Type: Array of String

Allowed values: Alarm | Sop | Test

Minimum: 1

Maximum: 4

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: Replacement

Return values

Ref

Fn::GetAtt

AppArn

Amazon Resource Name (ARN) of the Amazon 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 General Reference guide.

RecommendationTemplateArn

Amazon Resource Name (ARN) for the recommendation template.

Status

Status of the action.