Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdatePlan

Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.

Request Syntax


{
   "arn": "string",
   "associatedAlarms": { 
      "string" : { 
         "alarmType": "string",
         "crossAccountRole": "string",
         "externalId": "string",
         "resourceIdentifier": "string"
      }
   },
   "description": "string",
   "executionRole": "string",
   "recoveryTimeObjectiveMinutes": number,
   "reportConfiguration": { 
      "reportOutput": [ 
         { ... }
      ]
   },
   "triggers": [ 
      { 
         "action": "string",
         "conditions": [ 
            { 
               "associatedAlarmName": "string",
               "condition": "string"
            }
         ],
         "description": "string",
         "minDelayMinutesBetweenExecutions": number,
         "targetRegion": "string"
      }
   ],
   "workflows": [ 
      { 
         "steps": [ 
            { 
               "description": "string",
               "executionBlockConfiguration": { ... },
               "executionBlockType": "string",
               "name": "string"
            }
         ],
         "workflowDescription": "string",
         "workflowTargetAction": "string",
         "workflowTargetRegion": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the plan.

Type: String

Pattern: 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})

Required: Yes

associatedAlarms

The updated CloudWatch alarms associated with the plan.

Type: String to AssociatedAlarm object map

Required: No

description

The updated description for the Region switch plan.

Type: String

Required: No

executionRole

The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.

Type: String

Pattern: arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+

Required: Yes

recoveryTimeObjectiveMinutes

The updated target recovery time objective (RTO) in minutes for the plan.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10080.

Required: No

reportConfiguration

The updated report configuration for the plan.

Type: ReportConfiguration object

Required: No

triggers

The updated conditions that can automatically trigger the execution of the plan.

Type: Array of Trigger objects

Required: No

workflows

The updated workflows for the Region switch plan.

Type: Array of Workflow objects

Required: Yes

Response Syntax


{
   "plan": { 
      "arn": "string",
      "associatedAlarms": { 
         "string" : { 
            "alarmType": "string",
            "crossAccountRole": "string",
            "externalId": "string",
            "resourceIdentifier": "string"
         }
      },
      "description": "string",
      "executionRole": "string",
      "name": "string",
      "owner": "string",
      "primaryRegion": "string",
      "recoveryApproach": "string",
      "recoveryTimeObjectiveMinutes": number,
      "regions": [ "string" ],
      "reportConfiguration": { 
         "reportOutput": [ 
            { ... }
         ]
      },
      "triggers": [ 
         { 
            "action": "string",
            "conditions": [ 
               { 
                  "associatedAlarmName": "string",
                  "condition": "string"
               }
            ],
            "description": "string",
            "minDelayMinutesBetweenExecutions": number,
            "targetRegion": "string"
         }
      ],
      "updatedAt": number,
      "version": "string",
      "workflows": [ 
         { 
            "steps": [ 
               { 
                  "description": "string",
                  "executionBlockConfiguration": { ... },
                  "executionBlockType": "string",
                  "name": "string"
               }
            ],
            "workflowDescription": "string",
            "workflowTargetAction": "string",
            "workflowTargetRegion": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

plan

The details of the updated Region switch plan.

Type: Plan object

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404