backup_plan_templates
Creates, updates, deletes, gets or lists a backup_plan_templates resource.
Overview
| Name | backup_plan_templates |
| Type | Resource |
| Id | aws.backup.backup_plan_templates |
Fields
The following fields are returned by SELECT queries:
- list_backup_plan_templates
| Name | Datatype | Description |
|---|---|---|
backup_plan_template_id | string | Uniquely identifies a stored backup plan template. |
backup_plan_template_name | string | The optional display name of a backup plan template. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_backup_plan_templates | select | region | nextToken, maxResults | Lists 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
maxResults | integer | The maximum number of items to return. |
nextToken | string | The 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
- list_backup_plan_templates
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 }}'
;