AWS::ARCRegionSwitch::Plan

ARCRegionSwitch Plan

Represents a plan that specifies Regions, IAM roles, and workflows of logic required to perform the desired change to your multi-Region application

Properties

12 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`ExecutionRole`	`string`	Required
`Name`	`string`	RequiredCreate-only
`RecoveryApproach`	`string`	RequiredCreate-only
`Regions`	`Array<string>`	RequiredCreate-only
`Workflows`	`Array<Workflow>`	Required
`AssociatedAlarms`	`AssociatedAlarmMap`
`Description`	`string`
`PrimaryRegion`	`string`	Create-only
`RecoveryTimeObjectiveMinutes`	`number`
`ReportConfiguration`	`ReportConfiguration`
`Tags`	`Tags`
`Triggers`	`Array<Trigger>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-
`HealthChecksForPlan`	`object`	-
`Owner`	`string`	-
`PlanHealthChecks`	`Array<string>`	-
`Route53HealthChecks`	`object`	-
`Version`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ARCRegionSwitch::Plan

Resources:
  MyResource:
    Type: AWS::ARCRegionSwitch::Plan
    Properties:
      ExecutionRole: "value"
      Name: "my-name"
      RecoveryApproach: "value"
      Regions: []
      Workflows: []
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

arc-region-switch:CreatePlanarc-region-switch:GetPlanarc-region-switch:ListRoute53HealthChecksarc-region-switch:ListTagsForResourcearc-region-switch:TagResourceiam:PassRole

read

arc-region-switch:GetPlanarc-region-switch:ListRoute53HealthChecksarc-region-switch:ListTagsForResource

update

arc-region-switch:GetPlanarc-region-switch:ListRoute53HealthChecksarc-region-switch:ListTagsForResourcearc-region-switch:TagResourcearc-region-switch:UntagResourcearc-region-switch:UpdatePlaniam:PassRole

delete

arc-region-switch:DeletePlanarc-region-switch:GetPlan

list

arc-region-switch:ListPlans

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

ServiceARCRegionSwitch

Properties18

Required5

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NamePrimaryRegionRecoveryApproachRegions

External Links

AWS Documentation