Skip to main content

backup_plan_templates

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

Overview

Namebackup_plan_templates
TypeResource
Idaws.backup.backup_plan_templates

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
backup_plan_template_idstringUniquely identifies a stored backup plan template.
backup_plan_template_namestringThe optional display name of a backup plan template.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_backup_plan_templatesselectregionnextToken, maxResultsLists the backup plan templates.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of items to return.
nextTokenstringThe next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

SELECT examples

Lists the backup plan templates.

SELECT
backup_plan_template_id,
backup_plan_template_name
FROM aws.backup.backup_plan_templates
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;