AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ARCRegionSwitch::Plan

CfnPlan

Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.

Import

import { CfnPlan } from 'aws-cdk-lib/aws-arcregionswitch';

Or use the module namespace:

import * as arcregionswitch from 'aws-cdk-lib/aws-arcregionswitch';
// arcregionswitch.CfnPlan

Properties

Configuration passed to the constructor as CfnPlanProps.

executionRoleRequired
string

The execution role for a plan.

nameRequired
string

The name for a plan.

recoveryApproachRequired
string

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

regionsRequired
string[]

The AWS Regions for a plan.

workflowsRequired
IResolvable | IResolvable | WorkflowProperty[]

The workflows for a plan.

associatedAlarmsOptional
IResolvable | { [key: string]: IResolvable | AssociatedAlarmProperty }

The associated application health alarms for a plan.

descriptionOptional
string

The description for a plan.

primaryRegionOptional
string

The primary Region for a plan.

recoveryTimeObjectiveMinutesOptional
number

The recovery time objective for a plan.

reportConfigurationOptional
IResolvable | ReportConfigurationProperty

The report configuration for a plan.

tagsOptional
{ [key: string]: string }
triggersOptional
IResolvable | IResolvable | TriggerProperty[]

The triggers for a plan.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ARCRegionSwitch::PlanView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-arcregionswitch
CFN TypeAWS::ARCRegionSwitch::Plan
Properties12

Explore This Service

External Links