2025/12/19 - ARC - Region switch - 6 updated api methods
Changes Automatic Plan Execution Reports allow customers to maintain a concise record of their Region switch Plan executions. This enables customer SREs and leadership to have a clear view of their recovery posture based on the generated reports for their Plan executions.
{'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}
Response {'plan': {'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_plan(
description='string',
workflows=[
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
executionRole='string',
recoveryTimeObjectiveMinutes=123,
associatedAlarms={
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
triggers=[
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
reportConfiguration={
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
name='string',
regions=[
'string',
],
recoveryApproach='activeActive'|'activePassive',
primaryRegion='string',
tags={
'string': 'string'
}
)
string
The description of a Region switch plan.
list
[REQUIRED]
An array of workflows included in a Region switch plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) -- [REQUIRED]
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) -- [REQUIRED]
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) -- [REQUIRED]
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) -- [REQUIRED]
The retry interval specified.
regionToRun (string) -- [REQUIRED]
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) -- [REQUIRED]
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) -- [REQUIRED]
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) -- [REQUIRED]
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a routing control.
state (string) -- [REQUIRED]
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) -- [REQUIRED]
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) -- [REQUIRED]
The global cluster identifier for a global database.
databaseClusterArns (list) -- [REQUIRED]
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) -- [REQUIRED]
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) -- [REQUIRED]
The Kubernetes resource type for the configuration.
apiVersion (string) -- [REQUIRED]
The API version type for the Kubernetes resource.
kind (string) -- [REQUIRED]
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) -- [REQUIRED]
The namespace for the Kubernetes resource.
name (string) -- [REQUIRED]
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) -- [REQUIRED]
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) -- [REQUIRED]
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) -- [REQUIRED]
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) -- [REQUIRED]
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) -- [REQUIRED]
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) -- [REQUIRED]
The type of an execution block in a workflow.
workflowTargetAction (string) -- [REQUIRED]
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
string
[REQUIRED]
An execution role is a way to categorize a Region switch plan.
integer
Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.
dict
The alarms associated with a Region switch plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) -- [REQUIRED]
The resource identifier for alarms that you associate with a plan.
alarmType (string) -- [REQUIRED]
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
list
The triggers associated with a Region switch plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) -- [REQUIRED]
The Amazon Web Services Region for a trigger.
action (string) -- [REQUIRED]
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) -- [REQUIRED]
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) -- [REQUIRED]
The name of the CloudWatch alarm associated with the condition.
condition (string) -- [REQUIRED]
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) -- [REQUIRED]
The minimum time, in minutes, that must elapse between automatic executions of the plan.
dict
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.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
string
[REQUIRED]
The name of a Region switch plan.
list
[REQUIRED]
An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
(string) --
string
[REQUIRED]
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
string
The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.
dict
The tags to apply to the Region switch plan.
(string) --
(string) --
dict
Response Syntax
{
'plan': {
'arn': 'string',
'description': 'string',
'workflows': [
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
'executionRole': 'string',
'recoveryTimeObjectiveMinutes': 123,
'associatedAlarms': {
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
'triggers': [
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
'reportConfiguration': {
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'name': 'string',
'regions': [
'string',
],
'recoveryApproach': 'activeActive'|'activePassive',
'primaryRegion': 'string',
'owner': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
plan (dict) --
The details of the created Region switch plan.
arn (string) --
The Amazon Resource Name (ARN) of the plan.
description (string) --
The description for a plan.
workflows (list) --
The workflows for a plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) --
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) --
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) --
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) --
The retry interval specified.
regionToRun (string) --
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) --
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) --
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) --
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) --
The Amazon Resource Name (ARN) of a routing control.
state (string) --
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a global database.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) --
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) --
The Kubernetes resource type for the configuration.
apiVersion (string) --
The API version type for the Kubernetes resource.
kind (string) --
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) --
The namespace for the Kubernetes resource.
name (string) --
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) --
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) --
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) --
The type of an execution block in a workflow.
workflowTargetAction (string) --
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
executionRole (string) --
The execution role for a plan.
recoveryTimeObjectiveMinutes (integer) --
The recovery time objective for a plan.
associatedAlarms (dict) --
The associated application health alarms for a plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) --
The resource identifier for alarms that you associate with a plan.
alarmType (string) --
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
triggers (list) --
The triggers for a plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) --
The Amazon Web Services Region for a trigger.
action (string) --
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) --
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) --
The name of the CloudWatch alarm associated with the condition.
condition (string) --
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) --
The minimum time, in minutes, that must elapse between automatic executions of the plan.
reportConfiguration (dict) --
The report configuration for a plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
name (string) --
The name for a plan.
regions (list) --
The Amazon Web Services Regions for a plan.
(string) --
recoveryApproach (string) --
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
primaryRegion (string) --
The primary Region for a plan.
owner (string) --
The owner of a plan.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan was last updated.
{'plan': {'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}}
Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.
See also: AWS API Documentation
Request Syntax
client.get_plan(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the plan.
dict
Response Syntax
{
'plan': {
'arn': 'string',
'description': 'string',
'workflows': [
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
'executionRole': 'string',
'recoveryTimeObjectiveMinutes': 123,
'associatedAlarms': {
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
'triggers': [
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
'reportConfiguration': {
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'name': 'string',
'regions': [
'string',
],
'recoveryApproach': 'activeActive'|'activePassive',
'primaryRegion': 'string',
'owner': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
plan (dict) --
The detailed information about the requested Region switch plan.
arn (string) --
The Amazon Resource Name (ARN) of the plan.
description (string) --
The description for a plan.
workflows (list) --
The workflows for a plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) --
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) --
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) --
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) --
The retry interval specified.
regionToRun (string) --
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) --
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) --
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) --
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) --
The Amazon Resource Name (ARN) of a routing control.
state (string) --
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a global database.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) --
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) --
The Kubernetes resource type for the configuration.
apiVersion (string) --
The API version type for the Kubernetes resource.
kind (string) --
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) --
The namespace for the Kubernetes resource.
name (string) --
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) --
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) --
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) --
The type of an execution block in a workflow.
workflowTargetAction (string) --
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
executionRole (string) --
The execution role for a plan.
recoveryTimeObjectiveMinutes (integer) --
The recovery time objective for a plan.
associatedAlarms (dict) --
The associated application health alarms for a plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) --
The resource identifier for alarms that you associate with a plan.
alarmType (string) --
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
triggers (list) --
The triggers for a plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) --
The Amazon Web Services Region for a trigger.
action (string) --
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) --
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) --
The name of the CloudWatch alarm associated with the condition.
condition (string) --
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) --
The minimum time, in minutes, that must elapse between automatic executions of the plan.
reportConfiguration (dict) --
The report configuration for a plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
name (string) --
The name for a plan.
regions (list) --
The Amazon Web Services Regions for a plan.
(string) --
recoveryApproach (string) --
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
primaryRegion (string) --
The primary Region for a plan.
owner (string) --
The owner of a plan.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan was last updated.
{'generatedReportDetails': [{'reportGenerationTime': 'timestamp',
'reportOutput': {'failedReportOutput': {'errorCode': 'insufficientPermissions '
'| '
'invalidResource '
'| '
'configurationError',
'errorMessage': 'string'},
's3ReportOutput': {'s3ObjectKey': 'string'}}}],
'plan': {'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}}
Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
See also: AWS API Documentation
Request Syntax
client.get_plan_execution(
planArn='string',
executionId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the plan with the execution to retrieve.
string
[REQUIRED]
The execution identifier of a plan execution.
integer
The number of objects that you want to return with this call.
string
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.
dict
Response Syntax
{
'planArn': 'string',
'executionId': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1),
'comment': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'mode': 'graceful'|'ungraceful',
'executionState': 'inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth',
'executionAction': 'activate'|'deactivate',
'executionRegion': 'string',
'stepStates': [
{
'name': 'string',
'status': 'notStarted'|'running'|'failed'|'completed'|'canceled'|'skipped'|'pendingApproval',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'stepMode': 'graceful'|'ungraceful'
},
],
'plan': {
'arn': 'string',
'description': 'string',
'workflows': [
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
'executionRole': 'string',
'recoveryTimeObjectiveMinutes': 123,
'associatedAlarms': {
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
'triggers': [
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
'reportConfiguration': {
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'name': 'string',
'regions': [
'string',
],
'recoveryApproach': 'activeActive'|'activePassive',
'primaryRegion': 'string',
'owner': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1)
},
'actualRecoveryTime': 'string',
'generatedReportDetails': [
{
'reportGenerationTime': datetime(2015, 1, 1),
'reportOutput': {
's3ReportOutput': {
's3ObjectKey': 'string'
},
'failedReportOutput': {
'errorCode': 'insufficientPermissions'|'invalidResource'|'configurationError',
'errorMessage': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
planArn (string) --
The Amazon Resource Name (ARN) of the plan.
executionId (string) --
The execution identifier of a plan execution.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan execution was last updated.
comment (string) --
A comment included on the plan execution.
startTime (datetime) --
The time (UTC) when the plan execution started.
endTime (datetime) --
The time (UTC) when the plan execution ended.
mode (string) --
The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
executionState (string) --
The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
executionAction (string) --
The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
executionRegion (string) --
The Amazon Web Services Region for a plan execution.
stepStates (list) --
The states of the steps in the plan execution.
(dict) --
Represents the state of a step in a plan execution.
name (string) --
The name of a step in a workflow.
status (string) --
The status of a step in a workflow. For example, a status might be Completed or Pending Approval.
startTime (datetime) --
The timestamp when a step started execution.
endTime (datetime) --
The timestamp when a step endeded execution.
stepMode (string) --
The mode for a step execution. The mode can be Graceful or Ungraceful.
plan (dict) --
The details of the Region switch plan.
arn (string) --
The Amazon Resource Name (ARN) of the plan.
description (string) --
The description for a plan.
workflows (list) --
The workflows for a plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) --
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) --
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) --
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) --
The retry interval specified.
regionToRun (string) --
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) --
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) --
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) --
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) --
The Amazon Resource Name (ARN) of a routing control.
state (string) --
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a global database.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) --
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) --
The Kubernetes resource type for the configuration.
apiVersion (string) --
The API version type for the Kubernetes resource.
kind (string) --
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) --
The namespace for the Kubernetes resource.
name (string) --
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) --
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) --
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) --
The type of an execution block in a workflow.
workflowTargetAction (string) --
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
executionRole (string) --
The execution role for a plan.
recoveryTimeObjectiveMinutes (integer) --
The recovery time objective for a plan.
associatedAlarms (dict) --
The associated application health alarms for a plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) --
The resource identifier for alarms that you associate with a plan.
alarmType (string) --
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
triggers (list) --
The triggers for a plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) --
The Amazon Web Services Region for a trigger.
action (string) --
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) --
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) --
The name of the CloudWatch alarm associated with the condition.
condition (string) --
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) --
The minimum time, in minutes, that must elapse between automatic executions of the plan.
reportConfiguration (dict) --
The report configuration for a plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
name (string) --
The name for a plan.
regions (list) --
The Amazon Web Services Regions for a plan.
(string) --
recoveryApproach (string) --
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
primaryRegion (string) --
The primary Region for a plan.
owner (string) --
The owner of a plan.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan was last updated.
actualRecoveryTime (string) --
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.
generatedReportDetails (list) --
Information about the location of a generated report, or the cause of its failure.
(dict) --
Information about a generated execution report.
reportGenerationTime (datetime) --
The timestamp when the report was generated.
reportOutput (dict) --
The output location or cause of a failure in report generation.
s3ReportOutput (dict) --
Information about a report delivered to Amazon S3.
s3ObjectKey (string) --
The S3 object key where the generated report is stored.
failedReportOutput (dict) --
The details about a failed report generation.
errorCode (string) --
The error code for the failed report generation.
errorMessage (string) --
The error message for the failed report generation.
nextToken (string) --
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.
{'plan': {'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_plan_in_region(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the plan in Region.
dict
Response Syntax
{
'plan': {
'arn': 'string',
'description': 'string',
'workflows': [
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
'executionRole': 'string',
'recoveryTimeObjectiveMinutes': 123,
'associatedAlarms': {
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
'triggers': [
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
'reportConfiguration': {
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'name': 'string',
'regions': [
'string',
],
'recoveryApproach': 'activeActive'|'activePassive',
'primaryRegion': 'string',
'owner': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
plan (dict) --
The details of the Region switch plan.
arn (string) --
The Amazon Resource Name (ARN) of the plan.
description (string) --
The description for a plan.
workflows (list) --
The workflows for a plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) --
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) --
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) --
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) --
The retry interval specified.
regionToRun (string) --
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) --
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) --
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) --
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) --
The Amazon Resource Name (ARN) of a routing control.
state (string) --
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a global database.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) --
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) --
The Kubernetes resource type for the configuration.
apiVersion (string) --
The API version type for the Kubernetes resource.
kind (string) --
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) --
The namespace for the Kubernetes resource.
name (string) --
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) --
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) --
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) --
The type of an execution block in a workflow.
workflowTargetAction (string) --
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
executionRole (string) --
The execution role for a plan.
recoveryTimeObjectiveMinutes (integer) --
The recovery time objective for a plan.
associatedAlarms (dict) --
The associated application health alarms for a plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) --
The resource identifier for alarms that you associate with a plan.
alarmType (string) --
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
triggers (list) --
The triggers for a plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) --
The Amazon Web Services Region for a trigger.
action (string) --
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) --
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) --
The name of the CloudWatch alarm associated with the condition.
condition (string) --
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) --
The minimum time, in minutes, that must elapse between automatic executions of the plan.
reportConfiguration (dict) --
The report configuration for a plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
name (string) --
The name for a plan.
regions (list) --
The Amazon Web Services Regions for a plan.
(string) --
recoveryApproach (string) --
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
primaryRegion (string) --
The primary Region for a plan.
owner (string) --
The owner of a plan.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan was last updated.
{'items': {'executionBlockType': {'DocumentDb'},
'type': {'planEvaluationWarning'}}}
Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.
See also: AWS API Documentation
Request Syntax
client.list_plan_execution_events(
planArn='string',
executionId='string',
maxResults=123,
nextToken='string',
name='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the plan.
string
[REQUIRED]
The execution identifier of a plan execution.
integer
The number of objects that you want to return with this call.
string
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.
string
The name of the plan execution event.
dict
Response Syntax
{
'items': [
{
'timestamp': datetime(2015, 1, 1),
'type': 'unknown'|'executionPending'|'executionStarted'|'executionSucceeded'|'executionFailed'|'executionPausing'|'executionPaused'|'executionCanceling'|'executionCanceled'|'executionPendingApproval'|'executionBehaviorChangedToUngraceful'|'executionBehaviorChangedToGraceful'|'executionPendingChildPlanManualApproval'|'executionSuccessMonitoringApplicationHealth'|'stepStarted'|'stepUpdate'|'stepSucceeded'|'stepFailed'|'stepSkipped'|'stepPausedByError'|'stepPausedByOperator'|'stepCanceled'|'stepPendingApproval'|'stepExecutionBehaviorChangedToUngraceful'|'stepPendingApplicationHealthMonitor'|'planEvaluationWarning',
'stepName': 'string',
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb',
'resources': [
'string',
],
'error': 'string',
'description': 'string',
'eventId': 'string',
'previousEventId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The items in the plan execution event.
(dict) --
Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.
timestamp (datetime) --
The timestamp for an execution event.
type (string) --
The type of an execution event.
stepName (string) --
The step name for an execution event.
executionBlockType (string) --
The execution block type for an execution event.
resources (list) --
The resources for an execution event.
(string) --
error (string) --
Errors for an execution event.
description (string) --
The description for an execution event.
eventId (string) --
The event ID for an execution event.
previousEventId (string) --
The event ID of the previous execution event.
nextToken (string) --
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.
{'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}
Response {'plan': {'reportConfiguration': {'reportOutput': [{'s3Configuration': {'bucketOwner': 'string',
'bucketPath': 'string'}}]},
'workflows': {'steps': {'executionBlockConfiguration': {'documentDbConfig': {'behavior': 'switchoverOnly '
'| '
'failover',
'crossAccountRole': 'string',
'databaseClusterArns': ['string'],
'externalId': 'string',
'globalClusterIdentifier': 'string',
'timeoutMinutes': 'integer',
'ungraceful': {'ungraceful': 'failover'}}},
'executionBlockType': {'DocumentDb'}}}}}
Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
See also: AWS API Documentation
Request Syntax
client.update_plan(
arn='string',
description='string',
workflows=[
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
executionRole='string',
recoveryTimeObjectiveMinutes=123,
associatedAlarms={
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
triggers=[
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
reportConfiguration={
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the plan.
string
The updated description for the Region switch plan.
list
[REQUIRED]
The updated workflows for the Region switch plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) -- [REQUIRED]
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) -- [REQUIRED]
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) -- [REQUIRED]
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) -- [REQUIRED]
The retry interval specified.
regionToRun (string) -- [REQUIRED]
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) -- [REQUIRED]
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) -- [REQUIRED]
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) -- [REQUIRED]
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a routing control.
state (string) -- [REQUIRED]
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) -- [REQUIRED]
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) -- [REQUIRED]
The global cluster identifier for a global database.
databaseClusterArns (list) -- [REQUIRED]
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) -- [REQUIRED]
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) -- [REQUIRED]
The Kubernetes resource type for the configuration.
apiVersion (string) -- [REQUIRED]
The API version type for the Kubernetes resource.
kind (string) -- [REQUIRED]
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) -- [REQUIRED]
The namespace for the Kubernetes resource.
name (string) -- [REQUIRED]
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) -- [REQUIRED]
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) -- [REQUIRED]
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) -- [REQUIRED]
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) -- [REQUIRED]
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) -- [REQUIRED]
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) -- [REQUIRED]
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) -- [REQUIRED]
The type of an execution block in a workflow.
workflowTargetAction (string) -- [REQUIRED]
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
string
[REQUIRED]
The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
integer
The updated target recovery time objective (RTO) in minutes for the plan.
dict
The updated CloudWatch alarms associated with the plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) -- [REQUIRED]
The resource identifier for alarms that you associate with a plan.
alarmType (string) -- [REQUIRED]
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
list
The updated conditions that can automatically trigger the execution of the plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) -- [REQUIRED]
The Amazon Web Services Region for a trigger.
action (string) -- [REQUIRED]
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) -- [REQUIRED]
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) -- [REQUIRED]
The name of the CloudWatch alarm associated with the condition.
condition (string) -- [REQUIRED]
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) -- [REQUIRED]
The minimum time, in minutes, that must elapse between automatic executions of the plan.
dict
The updated report configuration for the plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
dict
Response Syntax
{
'plan': {
'arn': 'string',
'description': 'string',
'workflows': [
{
'steps': [
{
'name': 'string',
'description': 'string',
'executionBlockConfiguration': {
'customActionLambdaConfig': {
'timeoutMinutes': 123,
'lambdas': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'retryIntervalMinutes': ...,
'regionToRun': 'activatingRegion'|'deactivatingRegion',
'ungraceful': {
'behavior': 'skip'
}
},
'ec2AsgCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'asgs': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'autoscalingMaxInLast24Hours'
},
'executionApprovalConfig': {
'timeoutMinutes': 123,
'approvalRole': 'string'
},
'arcRoutingControlConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'regionAndRoutingControls': {
'string': [
{
'routingControlArn': 'string',
'state': 'On'|'Off'
},
]
}
},
'globalAuroraConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
},
'parallelConfig': {
'steps': {'... recursive ...'}
},
'regionSwitchPlanConfig': {
'crossAccountRole': 'string',
'externalId': 'string',
'arn': 'string'
},
'ecsCapacityIncreaseConfig': {
'timeoutMinutes': 123,
'services': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string',
'serviceArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'|'containerInsightsMaxInLast24Hours'
},
'eksResourceScalingConfig': {
'timeoutMinutes': 123,
'kubernetesResourceType': {
'apiVersion': 'string',
'kind': 'string'
},
'scalingResources': [
{
'string': {
'string': {
'namespace': 'string',
'name': 'string',
'hpaName': 'string'
}
}
},
],
'eksClusters': [
{
'crossAccountRole': 'string',
'externalId': 'string',
'clusterArn': 'string'
},
],
'ungraceful': {
'minimumSuccessPercentage': 123
},
'targetPercent': 123,
'capacityMonitoringApproach': 'sampledMaxInLast24Hours'
},
'route53HealthCheckConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'hostedZoneId': 'string',
'recordName': 'string',
'recordSets': [
{
'recordSetIdentifier': 'string',
'region': 'string'
},
]
},
'documentDbConfig': {
'timeoutMinutes': 123,
'crossAccountRole': 'string',
'externalId': 'string',
'behavior': 'switchoverOnly'|'failover',
'ungraceful': {
'ungraceful': 'failover'
},
'globalClusterIdentifier': 'string',
'databaseClusterArns': [
'string',
]
}
},
'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb'
},
],
'workflowTargetAction': 'activate'|'deactivate',
'workflowTargetRegion': 'string',
'workflowDescription': 'string'
},
],
'executionRole': 'string',
'recoveryTimeObjectiveMinutes': 123,
'associatedAlarms': {
'string': {
'crossAccountRole': 'string',
'externalId': 'string',
'resourceIdentifier': 'string',
'alarmType': 'applicationHealth'|'trigger'
}
},
'triggers': [
{
'description': 'string',
'targetRegion': 'string',
'action': 'activate'|'deactivate',
'conditions': [
{
'associatedAlarmName': 'string',
'condition': 'red'|'green'
},
],
'minDelayMinutesBetweenExecutions': 123
},
],
'reportConfiguration': {
'reportOutput': [
{
's3Configuration': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'name': 'string',
'regions': [
'string',
],
'recoveryApproach': 'activeActive'|'activePassive',
'primaryRegion': 'string',
'owner': 'string',
'version': 'string',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
plan (dict) --
The details of the updated Region switch plan.
arn (string) --
The Amazon Resource Name (ARN) of the plan.
description (string) --
The description for a plan.
workflows (list) --
The workflows for a plan.
(dict) --
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
steps (list) --
The steps that make up the workflow.
(dict) --
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
name (string) --
The name of a step in a workflow.
description (string) --
The description of a step in a workflow.
executionBlockConfiguration (dict) --
The configuration for an execution block in a workflow.
customActionLambdaConfig (dict) --
An Amazon Web Services Lambda execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
lambdas (list) --
The Amazon Web Services Lambda functions for the execution block.
(dict) --
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function.
retryIntervalMinutes (float) --
The retry interval specified.
regionToRun (string) --
The Amazon Web Services Region for the function to run in.
ungraceful (dict) --
The settings for ungraceful execution.
behavior (string) --
The ungraceful behavior for a Lambda function, which must be set to skip.
ec2AsgCapacityIncreaseConfig (dict) --
An EC2 Auto Scaling group execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
asgs (list) --
The EC2 Auto Scaling groups for the configuration.
(dict) --
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage that you specify for EC2 Auto Scaling groups.
targetPercent (integer) --
The target percentage that you specify for EC2 Auto Scaling groups.
capacityMonitoringApproach (string) --
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
executionApprovalConfig (dict) --
A manual approval execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
approvalRole (string) --
The IAM approval role for the configuration.
arcRoutingControlConfig (dict) --
An ARC routing control execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
regionAndRoutingControls (dict) --
The Region and ARC routing controls for the configuration.
(string) --
(list) --
(dict) --
Represents the state of an ARC routing control.
routingControlArn (string) --
The Amazon Resource Name (ARN) of a routing control.
state (string) --
The state of an ARC routing control, On or Off.
globalAuroraConfig (dict) --
An Aurora Global Database execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global database, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a global database.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a global database.
(string) --
parallelConfig (dict) --
A parallel configuration execution block.
steps (list) --
The steps for a parallel execution block.
regionSwitchPlanConfig (dict) --
A Region switch plan execution block.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
arn (string) --
The Amazon Resource Name (ARN) of the plan configuration.
ecsCapacityIncreaseConfig (dict) --
The capacity increase specified for the configuration.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
services (list) --
The services specified for the configuration.
(dict) --
The service for a cross account role.
crossAccountRole (string) --
The cross account role for a service.
externalId (string) --
The external ID (secret key) for the service.
clusterArn (string) --
The cluster Amazon Resource Name (ARN) for a service.
serviceArn (string) --
The Amazon Resource Name (ARN) for a service.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage specified for the configuration.
targetPercent (integer) --
The target percentage specified for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach specified for the configuration, for example, Most_Recent.
eksResourceScalingConfig (dict) --
An Amazon Web Services EKS resource scaling execution block.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
kubernetesResourceType (dict) --
The Kubernetes resource type for the configuration.
apiVersion (string) --
The API version type for the Kubernetes resource.
kind (string) --
The kind for the Kubernetes resource.
scalingResources (list) --
The scaling resources for the configuration.
(dict) --
(string) --
(dict) --
(string) --
(dict) --
Defines a Kubernetes resource to scale in an Amazon EKS cluster.
namespace (string) --
The namespace for the Kubernetes resource.
name (string) --
The name for the Kubernetes resource.
hpaName (string) --
The hpaname for the Kubernetes resource.
eksClusters (list) --
The clusters for the configuration.
(dict) --
The Amazon Web Services EKS cluster execution block configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
clusterArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.
ungraceful (dict) --
The settings for ungraceful execution.
minimumSuccessPercentage (integer) --
The minimum success percentage for the configuration.
targetPercent (integer) --
The target percentage for the configuration.
capacityMonitoringApproach (string) --
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
route53HealthCheckConfig (dict) --
The Amazon Route 53 health check configuration.
timeoutMinutes (integer) --
The Amazon Route 53 health check configuration time out (in minutes).
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
hostedZoneId (string) --
The Amazon Route 53 health check configuration hosted zone ID.
recordName (string) --
The Amazon Route 53 health check configuration record name.
recordSets (list) --
The Amazon Route 53 health check configuration record sets.
(dict) --
The Amazon Route 53 record set.
recordSetIdentifier (string) --
The Amazon Route 53 record set identifier.
region (string) --
The Amazon Route 53 record set Region.
documentDbConfig (dict) --
Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
timeoutMinutes (integer) --
The timeout value specified for the configuration.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
behavior (string) --
The behavior for a global cluster, that is, only allow switchover or also allow failover.
ungraceful (dict) --
The settings for ungraceful execution.
ungraceful (string) --
The settings for ungraceful execution.
globalClusterIdentifier (string) --
The global cluster identifier for a DocumentDB global cluster.
databaseClusterArns (list) --
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.
(string) --
executionBlockType (string) --
The type of an execution block in a workflow.
workflowTargetAction (string) --
The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
workflowTargetRegion (string) --
The Amazon Web Services Region that the workflow targets.
workflowDescription (string) --
The description of the workflow.
executionRole (string) --
The execution role for a plan.
recoveryTimeObjectiveMinutes (integer) --
The recovery time objective for a plan.
associatedAlarms (dict) --
The associated application health alarms for a plan.
(string) --
(dict) --
An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
crossAccountRole (string) --
The cross account role for the configuration.
externalId (string) --
The external ID (secret key) for the configuration.
resourceIdentifier (string) --
The resource identifier for alarms that you associate with a plan.
alarmType (string) --
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
triggers (list) --
The triggers for a plan.
(dict) --
Defines a condition that can automatically trigger the execution of a Region switch plan.
description (string) --
The description for a trigger.
targetRegion (string) --
The Amazon Web Services Region for a trigger.
action (string) --
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
conditions (list) --
The conditions that must be met for the trigger to fire.
(dict) --
Defines a condition that must be met for a trigger to fire.
associatedAlarmName (string) --
The name of the CloudWatch alarm associated with the condition.
condition (string) --
The condition that must be met. Valid values include ALARM and OK.
minDelayMinutesBetweenExecutions (integer) --
The minimum time, in minutes, that must elapse between automatic executions of the plan.
reportConfiguration (dict) --
The report configuration for a plan.
reportOutput (list) --
The output configuration for the report.
(dict) --
Configuration for report output destinations used in a Region switch plan.
s3Configuration (dict) --
Configuration for delivering reports to an Amazon S3 bucket.
bucketPath (string) --
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.
bucketOwner (string) --
The Amazon Web Services account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.
name (string) --
The name for a plan.
regions (list) --
The Amazon Web Services Regions for a plan.
(string) --
recoveryApproach (string) --
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
primaryRegion (string) --
The primary Region for a plan.
owner (string) --
The owner of a plan.
version (string) --
The version for the plan.
updatedAt (datetime) --
The timestamp when the plan was last updated.