Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.
Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.
For more information, see Region switch in ARC in the Amazon Application Recovery Controller User Guide.
", "operations": { "ApprovePlanExecutionStep": "Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.
You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.
", "CancelPlanExecution": "Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.
You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.
", "CreatePlan": "Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.
", "DeletePlan": "Deletes a Region switch plan. You must specify the ARN of the plan to delete.
You cannot delete a plan that has an active execution in progress.
", "GetPlan": "Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.
", "GetPlanEvaluationStatus": "Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
", "GetPlanExecution": "Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
", "GetPlanInRegion": "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.
", "ListPlanExecutionEvents": "Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.
", "ListPlanExecutions": "Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.
", "ListPlans": "Lists all Region switch plans in your Amazon Web Services account.
", "ListPlansInRegion": "Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
", "ListRoute53HealthChecks": "List the Amazon Route 53 health checks.
", "ListTagsForResource": "Lists the tags attached to a Region switch resource.
", "StartPlanExecution": "Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.
In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.
", "TagResource": "Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.
", "UntagResource": "Removes tags from a Region switch resource.
", "UpdatePlan": "Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
", "UpdatePlanExecution": "Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
", "UpdatePlanExecutionStep": "Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
" }, "shapes": { "AbbreviatedExecution": { "base": "A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.
", "refs": { "AbbreviatedExecutionsList$member": null } }, "AbbreviatedExecutionsList": { "base": null, "refs": { "ListPlanExecutionsResponse$items": "The items in the plan execution to return.
" } }, "AbbreviatedPlan": { "base": "A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.
", "refs": { "PlanList$member": null } }, "AbbreviatedPlanRecoveryTimeObjectiveMinutesInteger": { "base": null, "refs": { "AbbreviatedPlan$recoveryTimeObjectiveMinutes": "The recovery time objective that you've specified.
" } }, "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
HTTP Status Code: 403
", "refs": {} }, "AccountId": { "base": null, "refs": { "AbbreviatedPlan$owner": "The owner of a Region switch plan.
", "Plan$owner": "The owner of a plan.
" } }, "AlarmCondition": { "base": null, "refs": { "TriggerCondition$condition": "The condition that must be met. Valid values include ALARM and OK.
" } }, "AlarmType": { "base": null, "refs": { "AssociatedAlarm$alarmType": "The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
" } }, "Approval": { "base": null, "refs": { "ApprovePlanExecutionStepRequest$approval": "The status of approval for a plan execution step.
" } }, "ApprovePlanExecutionStepRequest": { "base": null, "refs": {} }, "ApprovePlanExecutionStepResponse": { "base": null, "refs": {} }, "ArcRoutingControlConfiguration": { "base": "Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.
", "refs": { "ExecutionBlockConfiguration$arcRoutingControlConfig": "An ARC routing control execution block.
" } }, "ArcRoutingControlConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "ArcRoutingControlConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "ArcRoutingControlState": { "base": "Represents the state of an ARC routing control.
", "refs": { "ArcRoutingControlStates$member": null } }, "ArcRoutingControlStates": { "base": null, "refs": { "RegionAndRoutingControls$value": null } }, "Asg": { "base": "Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
", "refs": { "AsgList$member": null } }, "AsgArn": { "base": null, "refs": { "Asg$arn": "The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
" } }, "AsgList": { "base": null, "refs": { "Ec2AsgCapacityIncreaseConfiguration$asgs": "The EC2 Auto Scaling groups for the configuration.
" } }, "AssociatedAlarm": { "base": "An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
", "refs": { "AssociatedAlarmMap$value": null } }, "AssociatedAlarmMap": { "base": null, "refs": { "CreatePlanRequest$associatedAlarms": "The alarms associated with a Region switch plan.
", "Plan$associatedAlarms": "The associated application health alarms for a plan.
", "UpdatePlanRequest$associatedAlarms": "The updated CloudWatch alarms associated with the plan.
" } }, "AuroraClusterArn": { "base": null, "refs": { "AuroraClusterArns$member": null } }, "AuroraClusterArns": { "base": null, "refs": { "GlobalAuroraConfiguration$databaseClusterArns": "The database cluster Amazon Resource Names (ARNs) for a global database.
" } }, "CancelPlanExecutionRequest": { "base": null, "refs": {} }, "CancelPlanExecutionResponse": { "base": null, "refs": {} }, "CreatePlanRequest": { "base": null, "refs": {} }, "CreatePlanRequestRecoveryTimeObjectiveMinutesInteger": { "base": null, "refs": { "CreatePlanRequest$recoveryTimeObjectiveMinutes": "Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.
" } }, "CreatePlanResponse": { "base": null, "refs": {} }, "CustomActionLambdaConfiguration": { "base": "Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.
", "refs": { "ExecutionBlockConfiguration$customActionLambdaConfig": "An Amazon Web Services Lambda execution block.
" } }, "CustomActionLambdaConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "CustomActionLambdaConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "DeletePlanRequest": { "base": null, "refs": {} }, "DeletePlanResponse": { "base": null, "refs": {} }, "Duration": { "base": null, "refs": { "AbbreviatedExecution$actualRecoveryTime": "The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
", "GetPlanExecutionResponse$actualRecoveryTime": "The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.
" } }, "Ec2AsgCapacityIncreaseConfiguration": { "base": "Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
", "refs": { "ExecutionBlockConfiguration$ec2AsgCapacityIncreaseConfig": "An EC2 Auto Scaling group execution block.
" } }, "Ec2AsgCapacityIncreaseConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "Ec2AsgCapacityIncreaseConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "Ec2AsgCapacityMonitoringApproach": { "base": null, "refs": { "Ec2AsgCapacityIncreaseConfiguration$capacityMonitoringApproach": "The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
" } }, "Ec2Ungraceful": { "base": "Configuration for handling failures when performing operations on EC2 resources.
", "refs": { "Ec2AsgCapacityIncreaseConfiguration$ungraceful": "The settings for ungraceful execution.
" } }, "Ec2UngracefulMinimumSuccessPercentageInteger": { "base": null, "refs": { "Ec2Ungraceful$minimumSuccessPercentage": "The minimum success percentage that you specify for EC2 Auto Scaling groups.
" } }, "EcsCapacityIncreaseConfiguration": { "base": "The configuration for an Amazon Web Services ECS capacity increase.
", "refs": { "ExecutionBlockConfiguration$ecsCapacityIncreaseConfig": "The capacity increase specified for the configuration.
" } }, "EcsCapacityIncreaseConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "EcsCapacityIncreaseConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "EcsCapacityMonitoringApproach": { "base": null, "refs": { "EcsCapacityIncreaseConfiguration$capacityMonitoringApproach": "The monitoring approach specified for the configuration, for example, Most_Recent.
The cluster Amazon Resource Name (ARN) for a service.
" } }, "EcsServiceArn": { "base": null, "refs": { "Service$serviceArn": "The Amazon Resource Name (ARN) for a service.
" } }, "EcsUngraceful": { "base": "The settings for ungraceful execution.
", "refs": { "EcsCapacityIncreaseConfiguration$ungraceful": "The settings for ungraceful execution.
" } }, "EcsUngracefulMinimumSuccessPercentageInteger": { "base": null, "refs": { "EcsUngraceful$minimumSuccessPercentage": "The minimum success percentage specified for the configuration.
" } }, "EksCapacityMonitoringApproach": { "base": null, "refs": { "EksResourceScalingConfiguration$capacityMonitoringApproach": "The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
" } }, "EksCluster": { "base": "The Amazon Web Services EKS cluster execution block configuration.
", "refs": { "EksClusters$member": null } }, "EksClusterArn": { "base": null, "refs": { "EksCluster$clusterArn": "The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
" } }, "EksClusters": { "base": null, "refs": { "EksResourceScalingConfiguration$eksClusters": "The clusters for the configuration.
" } }, "EksResourceScalingConfiguration": { "base": "The Amazon Web Services EKS resource scaling configuration.
", "refs": { "ExecutionBlockConfiguration$eksResourceScalingConfig": "An Amazon Web Services EKS resource scaling execution block.
" } }, "EksResourceScalingConfigurationTargetPercentInteger": { "base": null, "refs": { "EksResourceScalingConfiguration$targetPercent": "The target percentage for the configuration.
" } }, "EksResourceScalingConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "EksResourceScalingConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "EksResourceScalingUngraceful": { "base": "The ungraceful settings for Amazon Web Services EKS resource scaling.
", "refs": { "EksResourceScalingConfiguration$ungraceful": "The settings for ungraceful execution.
" } }, "EksResourceScalingUngracefulMinimumSuccessPercentageInteger": { "base": null, "refs": { "EksResourceScalingUngraceful$minimumSuccessPercentage": "The minimum success percentage for the configuration.
" } }, "EvaluationStatus": { "base": null, "refs": { "GetPlanEvaluationStatusResponse$evaluationState": "The evaluation state for the plan.
" } }, "ExecutionAction": { "base": null, "refs": { "AbbreviatedExecution$executionAction": "The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
The action for a minimal workflow, which can be Activate or Deactivate.
", "StartPlanExecutionRequest$action": "The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
" } }, "ExecutionApprovalConfiguration": { "base": "Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.
", "refs": { "ExecutionBlockConfiguration$executionApprovalConfig": "A manual approval execution block.
" } }, "ExecutionApprovalConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "ExecutionApprovalConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "ExecutionBlockConfiguration": { "base": "Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.
", "refs": { "Step$executionBlockConfiguration": "The configuration for an execution block in a workflow.
" } }, "ExecutionBlockType": { "base": null, "refs": { "ExecutionEvent$executionBlockType": "The execution block type for an execution event.
", "Step$executionBlockType": "The type of an execution block in a workflow.
" } }, "ExecutionComment": { "base": null, "refs": { "ApprovePlanExecutionStepRequest$comment": "A comment that you can enter about a plan execution.
", "CancelPlanExecutionRequest$comment": "A comment that you can enter about canceling a plan execution step.
", "StartPlanExecutionRequest$comment": "An optional comment explaining why the plan execution is being started.
", "UpdatePlanExecutionRequest$comment": "An optional comment about the plan execution.
", "UpdatePlanExecutionStepRequest$comment": "An optional comment about the plan execution.
" } }, "ExecutionEvent": { "base": "Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.
", "refs": { "ExecutionEventList$member": null } }, "ExecutionEventList": { "base": null, "refs": { "ListPlanExecutionEventsResponse$items": "The items in the plan execution event.
" } }, "ExecutionEventType": { "base": null, "refs": { "ExecutionEvent$type": "The type of an execution event.
" } }, "ExecutionId": { "base": null, "refs": { "AbbreviatedExecution$executionId": "The execution identifier of a plan execution.
", "AbbreviatedPlan$activePlanExecution": "Specifies if this is the active plan execution at this time.
", "ApprovePlanExecutionStepRequest$executionId": "The execution identifier of a plan execution.
", "CancelPlanExecutionRequest$executionId": "The execution identifier of a plan execution.
", "GetPlanExecutionRequest$executionId": "The execution identifier of a plan execution.
", "GetPlanExecutionResponse$executionId": "The execution identifier of a plan execution.
", "ListPlanExecutionEventsRequest$executionId": "The execution identifier of a plan execution.
", "StartPlanExecutionResponse$executionId": "The execution identifier of a plan execution.
", "UpdatePlanExecutionRequest$executionId": "The execution identifier of a plan execution.
", "UpdatePlanExecutionStepRequest$executionId": "The unique identifier of the plan execution containing the step to update.
" } }, "ExecutionMode": { "base": null, "refs": { "AbbreviatedExecution$mode": "The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
The mode for a step execution. The mode can be Graceful or Ungraceful.
" } }, "ExecutionState": { "base": null, "refs": { "AbbreviatedExecution$executionState": "The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
", "GetPlanExecutionResponse$executionState": "The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
", "ListPlanExecutionsRequest$state": "The state of the plan execution. For example, the plan execution might be In Progress.
" } }, "Float": { "base": null, "refs": { "CustomActionLambdaConfiguration$retryIntervalMinutes": "The retry interval specified.
" } }, "GetPlanEvaluationStatusRequest": { "base": null, "refs": {} }, "GetPlanEvaluationStatusResponse": { "base": null, "refs": {} }, "GetPlanExecutionRequest": { "base": null, "refs": {} }, "GetPlanExecutionResponse": { "base": null, "refs": {} }, "GetPlanExecutionStepStatesMaxResults": { "base": null, "refs": { "GetPlanExecutionRequest$maxResults": "The number of objects that you want to return with this call.
" } }, "GetPlanInRegionRequest": { "base": null, "refs": {} }, "GetPlanInRegionResponse": { "base": null, "refs": {} }, "GetPlanRequest": { "base": null, "refs": {} }, "GetPlanResponse": { "base": null, "refs": {} }, "GlobalAuroraConfiguration": { "base": "Configuration for Amazon Aurora global databases used in a Region switch plan.
", "refs": { "ExecutionBlockConfiguration$globalAuroraConfig": "An Aurora Global Database execution block.
" } }, "GlobalAuroraConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "GlobalAuroraConfiguration$timeoutMinutes": "The timeout value specified for the configuration.
" } }, "GlobalAuroraDefaultBehavior": { "base": null, "refs": { "GlobalAuroraConfiguration$behavior": "The behavior for a global database, that is, only allow switchover or also allow failover.
" } }, "GlobalAuroraUngraceful": { "base": "Configuration for handling failures when performing operations on Aurora global databases.
", "refs": { "GlobalAuroraConfiguration$ungraceful": "The settings for ungraceful execution.
" } }, "GlobalAuroraUngracefulBehavior": { "base": null, "refs": { "GlobalAuroraUngraceful$ungraceful": "The settings for ungraceful execution.
" } }, "GlobalClusterIdentifier": { "base": null, "refs": { "GlobalAuroraConfiguration$globalClusterIdentifier": "The global cluster identifier for a global database.
" } }, "IamRoleArn": { "base": null, "refs": { "ArcRoutingControlConfiguration$crossAccountRole": "The cross account role for the configuration.
", "Asg$crossAccountRole": "The cross account role for the configuration.
", "AssociatedAlarm$crossAccountRole": "The cross account role for the configuration.
", "CreatePlanRequest$executionRole": "An execution role is a way to categorize a Region switch plan.
", "EksCluster$crossAccountRole": "The cross account role for the configuration.
", "GlobalAuroraConfiguration$crossAccountRole": "The cross account role for the configuration.
", "Lambdas$crossAccountRole": "The cross account role for the configuration.
", "Plan$executionRole": "The execution role for a plan.
", "RegionSwitchPlanConfiguration$crossAccountRole": "The cross account role for the configuration.
", "Route53HealthCheckConfiguration$crossAccountRole": "The cross account role for the configuration.
", "Service$crossAccountRole": "The cross account role for a service.
", "UpdatePlanRequest$executionRole": "The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
" } }, "IllegalArgumentException": { "base": "The request processing has an invalid argument.
", "refs": {} }, "IllegalStateException": { "base": "The operation failed because the current state of the resource doesn't allow the operation to proceed.
HTTP Status Code: 400
", "refs": {} }, "Integer": { "base": null, "refs": { "Ec2AsgCapacityIncreaseConfiguration$targetPercent": "The target percentage that you specify for EC2 Auto Scaling groups.
", "EcsCapacityIncreaseConfiguration$targetPercent": "The target percentage specified for the configuration.
", "Trigger$minDelayMinutesBetweenExecutions": "The minimum time, in minutes, that must elapse between automatic executions of the plan.
" } }, "InternalServerException": { "base": "The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
", "refs": {} }, "KubernetesNamespace": { "base": null, "refs": { "KubernetesScalingResource$namespace": "The namespace for the Kubernetes resource.
" } }, "KubernetesResourceType": { "base": "Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
", "refs": { "EksResourceScalingConfiguration$kubernetesResourceType": "The Kubernetes resource type for the configuration.
" } }, "KubernetesScalingApplication": { "base": null, "refs": { "KubernetesScalingApps$member": null } }, "KubernetesScalingApps": { "base": null, "refs": { "EksResourceScalingConfiguration$scalingResources": "The scaling resources for the configuration.
" } }, "KubernetesScalingResource": { "base": "Defines a Kubernetes resource to scale in an Amazon EKS cluster.
", "refs": { "RegionalScalingResource$value": null } }, "LambdaArn": { "base": null, "refs": { "Lambdas$arn": "The Amazon Resource Name (ARN) of the Lambda function.
" } }, "LambdaList": { "base": null, "refs": { "CustomActionLambdaConfiguration$lambdas": "The Amazon Web Services Lambda functions for the execution block.
" } }, "LambdaUngraceful": { "base": "Configuration for handling failures when invoking Lambda functions.
", "refs": { "CustomActionLambdaConfiguration$ungraceful": "The settings for ungraceful execution.
" } }, "LambdaUngracefulBehavior": { "base": null, "refs": { "LambdaUngraceful$behavior": "The ungraceful behavior for a Lambda function, which must be set to skip.
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
", "refs": { "LambdaList$member": null } }, "ListExecutionEventsMaxResults": { "base": null, "refs": { "ListPlanExecutionEventsRequest$maxResults": "The number of objects that you want to return with this call.
" } }, "ListExecutionsMaxResults": { "base": null, "refs": { "ListPlanExecutionsRequest$maxResults": "The number of objects that you want to return with this call.
" } }, "ListPlanExecutionEventsRequest": { "base": null, "refs": {} }, "ListPlanExecutionEventsResponse": { "base": null, "refs": {} }, "ListPlanExecutionsRequest": { "base": null, "refs": {} }, "ListPlanExecutionsResponse": { "base": null, "refs": {} }, "ListPlansInRegionRequest": { "base": null, "refs": {} }, "ListPlansInRegionResponse": { "base": null, "refs": {} }, "ListPlansRequest": { "base": null, "refs": {} }, "ListPlansResponse": { "base": null, "refs": {} }, "ListRoute53HealthChecksRequest": { "base": null, "refs": {} }, "ListRoute53HealthChecksRequestMaxResultsInteger": { "base": null, "refs": { "ListRoute53HealthChecksRequest$maxResults": "The number of objects that you want to return with this call.
" } }, "ListRoute53HealthChecksResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "MaxResults": { "base": null, "refs": { "GetPlanEvaluationStatusRequest$maxResults": "The number of objects that you want to return with this call.
", "ListPlansInRegionRequest$maxResults": "The number of objects that you want to return with this call.
", "ListPlansRequest$maxResults": "The number of objects that you want to return with this call.
" } }, "MinimalWorkflow": { "base": "A simplified representation of a workflow in a Region switch plan.
", "refs": { "ResourceWarning$workflow": "The workflow for the resource warning.
" } }, "NextToken": { "base": null, "refs": { "GetPlanEvaluationStatusRequest$nextToken": "Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Configuration for steps that should be executed in parallel during a Region switch.
", "refs": { "ExecutionBlockConfiguration$parallelConfig": "A parallel configuration execution block.
" } }, "Plan": { "base": "Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
", "refs": { "CreatePlanResponse$plan": "The details of the created Region switch plan.
", "GetPlanExecutionResponse$plan": "The details of the Region switch plan.
", "GetPlanInRegionResponse$plan": "The details of the Region switch plan.
", "GetPlanResponse$plan": "The detailed information about the requested Region switch plan.
", "UpdatePlanResponse$plan": "The details of the updated Region switch plan.
" } }, "PlanArn": { "base": null, "refs": { "AbbreviatedExecution$planArn": "The Amazon Resource Name (ARN) of the plan.
", "AbbreviatedPlan$arn": "The Amazon Resource Name (ARN) of the Region switch plan.
", "ApprovePlanExecutionStepRequest$planArn": "The Amazon Resource Name (ARN) of the plan.
", "CancelPlanExecutionRequest$planArn": "The Amazon Resource Name (ARN) of the plan.
", "DeletePlanRequest$arn": "The Amazon Resource Name (ARN) of the plan.
", "GetPlanEvaluationStatusRequest$planArn": "The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
", "GetPlanEvaluationStatusResponse$planArn": "The Amazon Resource Name (ARN) of the plan.
", "GetPlanExecutionRequest$planArn": "The Amazon Resource Name (ARN) of the plan with the execution to retrieve.
", "GetPlanExecutionResponse$planArn": "The Amazon Resource Name (ARN) of the plan.
", "GetPlanInRegionRequest$arn": "The Amazon Resource Name (ARN) of the plan in Region.
", "GetPlanRequest$arn": "The Amazon Resource Name (ARN) of the plan.
", "ListPlanExecutionEventsRequest$planArn": "The Amazon Resource Name (ARN) of the plan.
", "ListPlanExecutionsRequest$planArn": "The ARN for the plan.
", "ListRoute53HealthChecksRequest$arn": "The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.
", "ListTagsForResourceRequest$arn": "The Amazon Resource Name (ARN) of the resource.
", "Plan$arn": "The Amazon Resource Name (ARN) of the plan.
", "RegionSwitchPlanConfiguration$arn": "The Amazon Resource Name (ARN) of the plan configuration.
", "StartPlanExecutionRequest$planArn": "The Amazon Resource Name (ARN) of the plan to execute.
", "StartPlanExecutionResponse$plan": "The details of the Region switch plan.
", "TagResourceRequest$arn": "The Amazon Resource Name (ARN) for a tag that you add to a resource.
", "UntagResourceRequest$arn": "The Amazon Resource Name (ARN) for a tag you remove a resource from.
", "UpdatePlanExecutionRequest$planArn": "The Amazon Resource Name (ARN) of the plan with the execution to update.
", "UpdatePlanExecutionStepRequest$planArn": "The Amazon Resource Name (ARN) of the plan containing the execution step to update.
", "UpdatePlanRequest$arn": "The Amazon Resource Name (ARN) of the plan.
" } }, "PlanList": { "base": null, "refs": { "ListPlansInRegionResponse$plans": "The plans that were requested.
", "ListPlansResponse$plans": "The plans that were requested.
" } }, "PlanName": { "base": null, "refs": { "AbbreviatedPlan$name": "The name of a Region switch plan.
", "CreatePlanRequest$name": "The name of a Region switch plan.
", "Plan$name": "The name for a plan.
" } }, "PlanRecoveryTimeObjectiveMinutesInteger": { "base": null, "refs": { "Plan$recoveryTimeObjectiveMinutes": "The recovery time objective for a plan.
" } }, "PlanWarnings": { "base": null, "refs": { "GetPlanEvaluationStatusResponse$warnings": "The current evaluation warnings for the plan.
" } }, "RecoveryApproach": { "base": null, "refs": { "AbbreviatedPlan$recoveryApproach": "The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
", "CreatePlanRequest$recoveryApproach": "The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
", "Plan$recoveryApproach": "The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
" } }, "Region": { "base": null, "refs": { "AbbreviatedPlan$primaryRegion": "The primary Region for a plan.
", "CreatePlanRequest$primaryRegion": "The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.
", "GetPlanEvaluationStatusResponse$region": "The Amazon Web Services Region for the plan.
", "Plan$primaryRegion": "The primary Region for a plan.
", "RegionList$member": null, "RegionalScalingResource$key": null, "Route53HealthCheck$region": "The Amazon Route 53 Region.
", "Route53ResourceRecordSet$region": "The Amazon Route 53 record set Region.
", "Trigger$targetRegion": "The Amazon Web Services Region for a trigger.
", "Workflow$workflowTargetRegion": "The Amazon Web Services Region that the workflow targets.
" } }, "RegionAndRoutingControls": { "base": null, "refs": { "ArcRoutingControlConfiguration$regionAndRoutingControls": "The Region and ARC routing controls for the configuration.
" } }, "RegionList": { "base": null, "refs": { "AbbreviatedPlan$regions": "The Amazon Web Services Region specified for a Region switch plan.
", "CreatePlanRequest$regions": "An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
", "Plan$regions": "The Amazon Web Services Regions for a plan.
" } }, "RegionSwitchPlanConfiguration": { "base": "Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.
", "refs": { "ExecutionBlockConfiguration$regionSwitchPlanConfig": "A Region switch plan execution block.
" } }, "RegionToRunIn": { "base": null, "refs": { "CustomActionLambdaConfiguration$regionToRun": "The Amazon Web Services Region for the function to run in.
" } }, "RegionalScalingResource": { "base": null, "refs": { "KubernetesScalingApplication$value": null } }, "ResourceArn": { "base": null, "refs": { "ResourceWarning$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "ResourceNotFoundException": { "base": "The specified resource was not found.
HTTP Status Code: 404
", "refs": {} }, "ResourceWarning": { "base": "Represents a warning about a resource in a Region switch plan.
", "refs": { "PlanWarnings$member": null } }, "ResourceWarningStatus": { "base": null, "refs": { "ResourceWarning$warningStatus": "The status of the resource warning.
" } }, "Resources": { "base": null, "refs": { "ExecutionEvent$resources": "The resources for an execution event.
" } }, "RoleArn": { "base": null, "refs": { "ExecutionApprovalConfiguration$approvalRole": "The IAM approval role for the configuration.
" } }, "Route53HealthCheck": { "base": "The Amazon Route 53 health check.
", "refs": { "Route53HealthCheckList$member": null } }, "Route53HealthCheckConfiguration": { "base": "The Amazon Route 53 health check configuration.
", "refs": { "ExecutionBlockConfiguration$route53HealthCheckConfig": "The Amazon Route 53 health check configuration.
" } }, "Route53HealthCheckConfigurationTimeoutMinutesInteger": { "base": null, "refs": { "Route53HealthCheckConfiguration$timeoutMinutes": "The Amazon Route 53 health check configuration time out (in minutes).
" } }, "Route53HealthCheckId": { "base": null, "refs": { "Route53HealthCheck$healthCheckId": "The Amazon Route 53 health check ID.
" } }, "Route53HealthCheckList": { "base": null, "refs": { "ListRoute53HealthChecksResponse$healthChecks": "List of the health checks requested.
" } }, "Route53HostedZoneId": { "base": null, "refs": { "ListRoute53HealthChecksRequest$hostedZoneId": "The hosted zone ID for the health checks.
", "Route53HealthCheck$hostedZoneId": "The Amazon Route 53 health check hosted zone ID.
", "Route53HealthCheckConfiguration$hostedZoneId": "The Amazon Route 53 health check configuration hosted zone ID.
" } }, "Route53RecordName": { "base": null, "refs": { "ListRoute53HealthChecksRequest$recordName": "The record name for the health checks.
", "Route53HealthCheck$recordName": "The Amazon Route 53 record name.
", "Route53HealthCheckConfiguration$recordName": "The Amazon Route 53 health check configuration record name.
" } }, "Route53ResourceRecordSet": { "base": "The Amazon Route 53 record set.
", "refs": { "Route53ResourceRecordSetList$member": null } }, "Route53ResourceRecordSetIdentifier": { "base": null, "refs": { "Route53ResourceRecordSet$recordSetIdentifier": "The Amazon Route 53 record set identifier.
" } }, "Route53ResourceRecordSetList": { "base": null, "refs": { "Route53HealthCheckConfiguration$recordSets": "The Amazon Route 53 health check configuration record sets.
" } }, "RoutingControlArn": { "base": null, "refs": { "ArcRoutingControlState$routingControlArn": "The Amazon Resource Name (ARN) of a routing control.
" } }, "RoutingControlStateChange": { "base": null, "refs": { "ArcRoutingControlState$state": "The state of an ARC routing control, On or Off.
" } }, "Service": { "base": "The service for a cross account role.
", "refs": { "ServiceList$member": null } }, "ServiceList": { "base": null, "refs": { "EcsCapacityIncreaseConfiguration$services": "The services specified for the configuration.
" } }, "StartPlanExecutionRequest": { "base": null, "refs": {} }, "StartPlanExecutionResponse": { "base": null, "refs": {} }, "Step": { "base": "Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
", "refs": { "Steps$member": null } }, "StepName": { "base": null, "refs": { "ApprovePlanExecutionStepRequest$stepName": "The name of a step in a plan execution.
", "ExecutionEvent$stepName": "The step name for an execution event.
", "ListPlanExecutionEventsRequest$name": "The name of the plan execution event.
", "ResourceWarning$stepName": "The name of the step for the resource warning.
", "Step$name": "The name of a step in a workflow.
", "StepState$name": "The name of a step in a workflow.
" } }, "StepState": { "base": "Represents the state of a step in a plan execution.
", "refs": { "StepStates$member": null } }, "StepStates": { "base": null, "refs": { "GetPlanExecutionResponse$stepStates": "The states of the steps in the plan execution.
" } }, "StepStatus": { "base": null, "refs": { "StepState$status": "The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
" } }, "Steps": { "base": null, "refs": { "ParallelExecutionBlockConfiguration$steps": "The steps for a parallel execution block.
", "Workflow$steps": "The steps that make up the workflow.
" } }, "String": { "base": null, "refs": { "AbbreviatedExecution$version": "The version for the plan.
", "AbbreviatedExecution$comment": "An optional comment about the plan execution.
", "AbbreviatedExecution$executionRegion": "The Amazon Web Services Region for a plan execution.
", "AbbreviatedPlan$version": "The version for the plan.
", "AbbreviatedPlan$description": "The description of a Region switch plan.
", "AbbreviatedPlan$executionRole": "The execution role is a way to categorize a Region switch plan.
", "AccessDeniedException$message": null, "ArcRoutingControlConfiguration$externalId": "The external ID (secret key) for the configuration.
", "Asg$externalId": "The external ID (secret key) for the configuration.
", "AssociatedAlarm$externalId": "The external ID (secret key) for the configuration.
", "AssociatedAlarm$resourceIdentifier": "The resource identifier for alarms that you associate with a plan.
", "AssociatedAlarmMap$key": null, "CreatePlanRequest$description": "The description of a Region switch plan.
", "EksCluster$externalId": "The external ID (secret key) for the configuration.
", "ExecutionEvent$error": "Errors for an execution event.
", "ExecutionEvent$description": "The description for an execution event.
", "ExecutionEvent$eventId": "The event ID for an execution event.
", "ExecutionEvent$previousEventId": "The event ID of the previous execution event.
", "GetPlanEvaluationStatusResponse$lastEvaluatedVersion": "The version of the last evaluation of the plan.
", "GetPlanExecutionRequest$nextToken": "Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
The version for the plan.
", "GetPlanExecutionResponse$comment": "A comment included on the plan execution.
", "GetPlanExecutionResponse$executionRegion": "The Amazon Web Services Region for a plan execution.
", "GetPlanExecutionResponse$nextToken": "Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
The external ID (secret key) for the configuration.
", "IllegalArgumentException$message": null, "IllegalStateException$message": null, "InternalServerException$message": null, "KubernetesResourceType$apiVersion": "The API version type for the Kubernetes resource.
", "KubernetesResourceType$kind": "The kind for the Kubernetes resource.
", "KubernetesScalingApplication$key": null, "KubernetesScalingResource$name": "The name for the Kubernetes resource.
", "KubernetesScalingResource$hpaName": "The hpaname for the Kubernetes resource.
", "Lambdas$externalId": "The external ID (secret key) for the configuration.
", "ListPlanExecutionEventsRequest$nextToken": "Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
The name for a minimal workflow
", "Plan$description": "The description for a plan.
", "Plan$version": "The version for the plan.
", "RegionAndRoutingControls$key": null, "RegionSwitchPlanConfiguration$externalId": "The external ID (secret key) for the configuration.
", "ResourceNotFoundException$message": null, "ResourceWarning$version": "The version for the resource warning.
", "ResourceWarning$warningMessage": "The warning message about what needs to be corrected.
", "Resources$member": null, "Route53HealthCheckConfiguration$externalId": "The external ID (secret key) for the configuration.
", "Service$externalId": "The external ID (secret key) for the service.
", "StartPlanExecutionRequest$targetRegion": "The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
", "StartPlanExecutionRequest$latestVersion": "A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
", "StartPlanExecutionResponse$planVersion": "The version of the plan, a unique number generated by Region switch.
", "StartPlanExecutionResponse$activateRegion": "The Amazon Web Services Region to activate.
", "StartPlanExecutionResponse$deactivateRegion": "The Amazon Web Services Region to deactivate.
", "Step$description": "The description of a step in a workflow.
", "Trigger$description": "The description for a trigger.
", "TriggerCondition$associatedAlarmName": "The name of the CloudWatch alarm associated with the condition.
", "UpdatePlanExecutionStepRequest$stepName": "The name of the execution step to update.
", "UpdatePlanRequest$description": "The updated description for the Region switch plan.
", "Workflow$workflowDescription": "The description of the workflow.
" } }, "TagKey": { "base": null, "refs": { "TagKeys$member": null, "Tags$key": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$resourceTagKeys": "Tag keys that you remove from a resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "CreatePlanRequest$tags": "The tags to apply to the Region switch plan.
", "ListTagsForResourceResponse$resourceTags": "The tags for a resource.
", "TagResourceRequest$tags": "Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.
" } }, "Timestamp": { "base": null, "refs": { "AbbreviatedExecution$updatedAt": "The timestamp when the plan execution was last updated.
", "AbbreviatedExecution$startTime": "The timestamp when the plan execution was started.
", "AbbreviatedExecution$endTime": "The timestamp when the plan execution was ended.
", "AbbreviatedPlan$updatedAt": "The timestamp when the plan execution was last updated.
", "ExecutionEvent$timestamp": "The timestamp for an execution event.
", "GetPlanEvaluationStatusResponse$lastEvaluationTime": "The time of the last time that Region switch ran an evaluation of the plan.
", "GetPlanExecutionResponse$updatedAt": "The timestamp when the plan execution was last updated.
", "GetPlanExecutionResponse$startTime": "The time (UTC) when the plan execution started.
", "GetPlanExecutionResponse$endTime": "The time (UTC) when the plan execution ended.
", "Plan$updatedAt": "The timestamp when the plan was last updated.
", "ResourceWarning$warningUpdatedTime": "The timestamp when the warning was last updated.
", "StepState$startTime": "The timestamp when a step started execution.
", "StepState$endTime": "The timestamp when a step endeded execution.
" } }, "Trigger": { "base": "Defines a condition that can automatically trigger the execution of a Region switch plan.
", "refs": { "TriggerList$member": null } }, "TriggerCondition": { "base": "Defines a condition that must be met for a trigger to fire.
", "refs": { "TriggerConditionList$member": null } }, "TriggerConditionList": { "base": null, "refs": { "Trigger$conditions": "The conditions that must be met for the trigger to fire.
" } }, "TriggerList": { "base": null, "refs": { "CreatePlanRequest$triggers": "The triggers associated with a Region switch plan.
", "Plan$triggers": "The triggers for a plan.
", "UpdatePlanRequest$triggers": "The updated conditions that can automatically trigger the execution of the plan.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdatePlanExecutionAction": { "base": null, "refs": { "UpdatePlanExecutionRequest$action": "The action specified for a plan execution, for example, Switch to Graceful or Pause.
" } }, "UpdatePlanExecutionRequest": { "base": null, "refs": {} }, "UpdatePlanExecutionResponse": { "base": null, "refs": {} }, "UpdatePlanExecutionStepAction": { "base": null, "refs": { "UpdatePlanExecutionStepRequest$actionToTake": "The updated action to take for the step. This can be used to skip or retry a step.
" } }, "UpdatePlanExecutionStepRequest": { "base": null, "refs": {} }, "UpdatePlanExecutionStepResponse": { "base": null, "refs": {} }, "UpdatePlanRequest": { "base": null, "refs": {} }, "UpdatePlanRequestRecoveryTimeObjectiveMinutesInteger": { "base": null, "refs": { "UpdatePlanRequest$recoveryTimeObjectiveMinutes": "The updated target recovery time objective (RTO) in minutes for the plan.
" } }, "UpdatePlanResponse": { "base": null, "refs": {} }, "Workflow": { "base": "Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
", "refs": { "WorkflowList$member": null } }, "WorkflowList": { "base": null, "refs": { "CreatePlanRequest$workflows": "An array of workflows included in a Region switch plan.
", "Plan$workflows": "The workflows for a plan.
", "UpdatePlanRequest$workflows": "The updated workflows for the Region switch plan.
" } }, "WorkflowTargetAction": { "base": null, "refs": { "Trigger$action": "The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
", "Workflow$workflowTargetAction": "The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
" } } } }