plans_in_regions

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

Overview

Name	plans_in_regions
Type	Resource
Id	aws.arc_region_switch.plans_in_regions

Fields

The following fields are returned by SELECT queries:

list_plans_in_region

Name	Datatype	Description
name	string	The name of a Region switch plan. (pattern: <code>[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?</code>)
active_plan_execution	string	Specifies if this is the active plan execution at this time.
arn	string	The Amazon Resource Name (ARN) of the Region switch plan. (pattern: <code>arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})</code>)
description	string	The description of a Region switch plan.
execution_role	string	The execution role is a way to categorize a Region switch plan.
owner	string	The owner of a Region switch plan. (pattern: <code>\d{12}</code>)
primary_region	string	The primary Region for a plan. (pattern: <code>[a-z]{2}-[a-z-]+-\d+</code>)
recovery_approach	string	The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive). (activeActive, activePassive)
recovery_time_objective_minutes	integer	The recovery time objective that you've specified.
regions	array	The Amazon Web Services Region specified for a Region switch plan.
updated_at	string (date-time)	The timestamp when the plan execution was last updated.
version	string	The version for the plan.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_plans_in_region	select	region		Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

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

list_plans_in_region

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

SELECT
name,
active_plan_execution,
arn,
description,
execution_role,
owner,
primary_region,
recovery_approach,
recovery_time_objective_minutes,
regions,
updated_at,
version
FROM aws.arc_region_switch.plans_in_regions
WHERE region = '{{ region }}' -- required
;