RecommendationTemplate
Defines a recommendation template created with the CreateRecommendationTemplate action.
Contents
- 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 AWS General Reference guide.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}$Required: Yes
- format
-
Format of the recommendation template.
- CfnJson
-
The template is AWS CloudFormation JSON.
- CfnYaml
-
The template is AWS CloudFormation YAML.
Type: String
Valid Values:
CfnYaml | CfnJsonRequired: Yes
- name
-
Name for the recommendation template.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$Required: Yes
- recommendationTemplateArn
-
Amazon Resource Name (ARN) for the recommendation template.
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}$Required: Yes
- 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.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Valid Values:
Alarm | Sop | TestRequired: Yes
- status
-
Status of the action.
Type: String
Valid Values:
Pending | InProgress | Failed | SuccessRequired: Yes
- appArn
-
Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.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}$Required: No
- endTime
-
The end time for the action.
Type: Timestamp
Required: No
- message
-
Message for the recommendation template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
- needsReplacements
-
Indicates if replacements are needed.
Type: Boolean
Required: No
- recommendationIds
-
Identifiers for the recommendations used in the recommendation template.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$Required: No
- startTime
-
The start time for the action.
Type: Timestamp
Required: No
-
Tags assigned to the resource. A tag is a label that you assign to an AWS resource. Each tag consists of a key/value pair.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[^\x00-\x1f\x22]+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^[^\x00-\x1f\x22]*$Required: No
- templatesLocation
-
The file location of the template.
Type: S3Location object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
