plan_in_regions

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

Overview

Name	plan_in_regions
Type	Resource
Id	aws.arc_region_switch.plan_in_regions

Fields

The following fields are returned by SELECT queries:

get_plan_in_region

Name	Datatype	Description
name	string	The name for a plan. (pattern: <code>[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?</code>)
arn	string	The Amazon Resource Name (ARN) of the 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>)
associated_alarms	object	The associated application health alarms for a plan.
description	string	The description for a plan.
execution_role	string	The execution role for a plan. (pattern: <code>arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+</code>)
owner	string	The owner of a 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 for a plan.
regions	array	The Amazon Web Services Regions for a plan.
report_configuration	object	Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.
triggers	array	The triggers for a plan.
updated_at	string (date-time)	The timestamp when the plan was last updated.
version	string	The version for the plan.
workflows	array	The workflows for a plan.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_plan_in_region	select	region		Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

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_plan_in_region

Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

SELECT
name,
arn,
associated_alarms,
description,
execution_role,
owner,
primary_region,
recovery_approach,
recovery_time_objective_minutes,
regions,
report_configuration,
triggers,
updated_at,
version,
workflows
FROM aws.arc_region_switch.plan_in_regions
WHERE region = '{{ region }}' -- required
;