Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Abbreviated
Execution A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.
- Abbreviated
Plan A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.
- ArcRouting
Control Configuration Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.
- ArcRouting
Control State Represents the state of an ARC routing control.
- Asg
Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
- Associated
Alarm An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
- Custom
Action Lambda Configuration Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.
- Ec2Asg
Capacity Increase Configuration Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
- Ec2Ungraceful
Configuration for handling failures when performing operations on EC2 resources.
- EcsCapacity
Increase Configuration The configuration for an Amazon Web Services ECS capacity increase.
- EcsUngraceful
The settings for ungraceful execution.
- EksCluster
The Amazon Web Services EKS cluster execution block configuration.
- EksResource
Scaling Configuration The Amazon Web Services EKS resource scaling configuration.
- EksResource
Scaling Ungraceful The ungraceful settings for Amazon Web Services EKS resource scaling.
- Execution
Approval Configuration Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.
- Execution
Event Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.
- Global
Aurora Configuration Configuration for Amazon Aurora global databases used in a Region switch plan.
- Global
Aurora Ungraceful Configuration for handling failures when performing operations on Aurora global databases.
- Kubernetes
Resource Type Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
- Kubernetes
Scaling Resource Defines a Kubernetes resource to scale in an Amazon EKS cluster.
- Lambda
Ungraceful Configuration for handling failures when invoking Lambda functions.
- Lambdas
Configuration for Amazon Web Services Lambda functions used in a Region switch plan.
- Minimal
Workflow A simplified representation of a workflow in a Region switch plan.
- Parallel
Execution Block Configuration Configuration for steps that should be executed in parallel during a Region switch.
- Plan
Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
- Region
Switch Plan Configuration Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.
- Resource
Warning Represents a warning about a resource in a Region switch plan.
- Route53
Health Check The Amazon Route 53 health check.
- Route53
Health Check Configuration The Amazon Route 53 health check configuration.
- Route53
Resource Record Set The Amazon Route 53 record set.
- Service
The service for a cross account role.
- Step
Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
- Step
State Represents the state of a step in a plan execution.
- Trigger
Defines a condition that can automatically trigger the execution of a Region switch plan.
- Trigger
Condition Defines a condition that must be met for a trigger to fire.
- Workflow
Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
Enums§
- Alarm
Condition - When writing a match expression against
AlarmCondition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Alarm
Type - When writing a match expression against
AlarmType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Approval
- When writing a match expression against
Approval, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Ec2Asg
Capacity Monitoring Approach - When writing a match expression against
Ec2AsgCapacityMonitoringApproach, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - EcsCapacity
Monitoring Approach - When writing a match expression against
EcsCapacityMonitoringApproach, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - EksCapacity
Monitoring Approach - When writing a match expression against
EksCapacityMonitoringApproach, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Evaluation
Status - When writing a match expression against
EvaluationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Action - When writing a match expression against
ExecutionAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Block Configuration Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.
- Execution
Block Type - When writing a match expression against
ExecutionBlockType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Event Type - When writing a match expression against
ExecutionEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Mode - When writing a match expression against
ExecutionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
State - When writing a match expression against
ExecutionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Global
Aurora Default Behavior - When writing a match expression against
GlobalAuroraDefaultBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Global
Aurora Ungraceful Behavior - When writing a match expression against
GlobalAuroraUngracefulBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Lambda
Ungraceful Behavior - When writing a match expression against
LambdaUngracefulBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recovery
Approach - When writing a match expression against
RecoveryApproach, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Region
ToRun In - When writing a match expression against
RegionToRunIn, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Resource
Warning Status - When writing a match expression against
ResourceWarningStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Routing
Control State Change - When writing a match expression against
RoutingControlStateChange, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Step
Status - When writing a match expression against
StepStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Update
Plan Execution Action - When writing a match expression against
UpdatePlanExecutionAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Update
Plan Execution Step Action - When writing a match expression against
UpdatePlanExecutionStepAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Target Action - When writing a match expression against
WorkflowTargetAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.