create_practice_run_configuration
async
¶
create_practice_run_configuration(
resource_identifier: ResourceIdentifier,
outcome_alarms: OutcomeAlarms,
*,
config_overrides: Optional[AsyncARCZonalShiftClientConfig] = None,
blocked_windows: Optional[BlockedWindows] = None,
blocked_dates: Optional[BlockedDates] = None,
blocking_alarms: Optional[BlockingAlarms] = None,
allowed_windows: Optional[AllowedWindows] = None,
) -> CreatePracticeRunConfigurationResponse
A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
When a resource has a practice run configuration, ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Parameters:
-
resource_identifier(ResourceIdentifier) –The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
-
blocked_windows(Optional[BlockedWindows], default:None) –Optionally, you can block ARC from starting practice runs for specific windows of days and times.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you could set the following recurring days and times as blocked windows, for example:
Mon:00:00-Mon:10:00 Wed-20:30-Wed:21:30 Fri-20:30-Fri:21:30.The
blockedWindowshave to start and end on the same day. Windows that span multiple days aren't supported. -
blocked_dates(Optional[BlockedDates], default:None) –Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.
The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for
2024-05-01. -
blocking_alarms(Optional[BlockingAlarms], default:None) –Blocking alarms for practice runs are optional alarms that you can specify that block practice runs when one or more of the alarms is in an
ALARMstate. -
allowed_windows(Optional[AllowedWindows], default:None) –Optionally, you can allow ARC to start practice runs for specific windows of days and times.
The format for allowed windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple allowed windows with spaces.
For example, say you want to allow practice runs only on Wednesdays and Fridays from noon to 5 p.m. For this scenario, you could set the following recurring days and times as allowed windows, for example:
Wed-12:00-Wed:17:00 Fri-12:00-Fri:17:00.The
allowedWindowshave to start and end on the same day. Windows that span multiple days aren't supported. -
outcome_alarms(OutcomeAlarms) –Outcome alarms for practice runs are alarms that you specify that end a practice run when one or more of the alarms is in an
ALARMstate.Configure one or more of these alarms to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure these alarms to go into an
ALARMstate if you want to stop a zonal shift, to let traffic for the resource return to the original Availability Zone.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ConflictException–The request could not be processed because of conflict in the current state of the resource.
-
InternalServerException–There was an internal server error.
-
ResourceNotFoundException–The input requested a resource that was not found.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_arc_zonal_shift/_services/async_arc_zonal_shift.py
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 | |