backup_plan_from_jsons

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

Overview

Name	backup_plan_from_jsons
Type	Resource
Id	aws.backup.backup_plan_from_jsons

Fields

The following fields are returned by SELECT queries:

get_backup_plan_from_json

Name	Datatype	Description
advanced_backup_settings	array	Contains a list of BackupOptions for each resource type.
backup_plan_name	string	The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters. If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.
rules	array	An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
scan_settings	array	Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_backup_plan_from_json	select	region		Returns a valid JSON document specifying a backup plan or an error.

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)

SELECT examples

get_backup_plan_from_json

Returns a valid JSON document specifying a backup plan or an error.

SELECT
advanced_backup_settings,
backup_plan_name,
rules,
scan_settings
FROM aws.backup.backup_plan_from_jsons
WHERE region = '{{ region }}' -- required
;