recommendation_templates

Creates, updates, deletes, gets or lists a recommendation_templates resource.

Overview

Name	recommendation_templates
Type	Resource
Id	aws.resiliencehub.recommendation_templates

Fields

The following fields are returned by SELECT queries:

list_recommendation_templates

Name	Datatype	Description
next_token	string	Token for the next set of results, or null if there are no more results. (pattern: <code>^\S{1,2000}$</code>)
recommendation_templates	array	The recommendation templates for the Resilience Hub applications.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_recommendation_templates	select	region	assessmentArn, maxResults, name, nextToken, recommendationTemplateArn, reverseOrder, status	Lists the recommendation templates for the Resilience Hub applications.
create_recommendation_template	insert	region, assessmentArn, name		Creates a new recommendation template for the Resilience Hub application.
delete_recommendation_template	delete	region		Deletes a recommendation template. This is a destructive action that can't be undone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
assessmentArn	string	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.
maxResults	integer	Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
name	string	The name for one of the listed recommendation templates.
nextToken	string	Null, or the token from a previous call to get the next set of results.
recommendationTemplateArn	string	The Amazon Resource Name (ARN) for a recommendation template.
reverseOrder	boolean	The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
status	array	Status of the action.

SELECT examples

list_recommendation_templates

Lists the recommendation templates for the Resilience Hub applications.

SELECT
next_token,
recommendation_templates
FROM aws.resiliencehub.recommendation_templates
WHERE region = '{{ region }}' -- required
AND assessmentArn = '{{ assessmentArn }}'
AND maxResults = '{{ maxResults }}'
AND name = '{{ name }}'
AND nextToken = '{{ nextToken }}'
AND recommendationTemplateArn = '{{ recommendationTemplateArn }}'
AND reverseOrder = '{{ reverseOrder }}'
AND status = '{{ status }}'
;

INSERT examples

create_recommendation_template

Creates a new recommendation template for the Resilience Hub application.

INSERT INTO aws.resiliencehub.recommendation_templates (
assessmentArn,
bucketName,
clientToken,
format,
name,
recommendationIds,
recommendationTypes,
tags,
region
)
SELECT 
'{{ assessmentArn }}' /* required */,
'{{ bucketName }}',
'{{ clientToken }}',
'{{ format }}',
'{{ name }}' /* required */,
'{{ recommendationIds }}',
'{{ recommendationTypes }}',
'{{ tags }}',
'{{ region }}'
RETURNING
recommendation_template
;

Manifest

# Description fields are for documentation purposes
- name: recommendation_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recommendation_templates resource.
  - name: assessmentArn
    value: "{{ assessmentArn }}"
  - name: bucketName
    value: "{{ bucketName }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: format
    value: "{{ format }}"
    valid_values: ['CfnYaml', 'CfnJson']
  - name: name
    value: "{{ name }}"
  - name: recommendationIds
    value:
      - "{{ recommendationIds }}"
  - name: recommendationTypes
    value:
      - "{{ recommendationTypes }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_recommendation_template

Deletes a recommendation template. This is a destructive action that can't be undone.

DELETE FROM aws.resiliencehub.recommendation_templates
WHERE region = '{{ region }}' --required
;