ARCZonalShift / Client / create_practice_run_configuration

create_practice_run_configuration#

ARCZonalShift.Client.create_practice_run_configuration(**kwargs)#

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, Route 53 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 Route 53 Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_practice_run_configuration(
    blockedDates=[
        'string',
    ],
    blockedWindows=[
        'string',
    ],
    blockingAlarms=[
        {
            'alarmIdentifier': 'string',
            'type': 'CLOUDWATCH'
        },
    ],
    outcomeAlarms=[
        {
            'alarmIdentifier': 'string',
            'type': 'CLOUDWATCH'
        },
    ],
    resourceIdentifier='string'
)
Parameters:

  • blockedDates (list) –

    Optionally, you can block Route 53 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.

    • (string) –

  • blockedWindows (list) –

    Optionally, you can block Route 53 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 might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

    • (string) –

  • blockingAlarms (list) –

    An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, and ends a practice run that’s in progress, when the alarm is in an ALARM state.

    • (dict) –

      A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. 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 or to interrupt a practice run in progress.

      Control condition alarms do not apply for autoshifts.

      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

      • alarmIdentifier (string) – [REQUIRED]

        The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.

      • type (string) – [REQUIRED]

        The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.

  • outcomeAlarms (list) –

    [REQUIRED]

    The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

    Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

    • (dict) –

      A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. 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 or to interrupt a practice run in progress.

      Control condition alarms do not apply for autoshifts.

      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

      • alarmIdentifier (string) – [REQUIRED]

        The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.

      • type (string) – [REQUIRED]

        The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.

  • resourceIdentifier (string) –

    [REQUIRED]

    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.

    At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'practiceRunConfiguration': {
        'blockedDates': [
            'string',
        ],
        'blockedWindows': [
            'string',
        ],
        'blockingAlarms': [
            {
                'alarmIdentifier': 'string',
                'type': 'CLOUDWATCH'
            },
        ],
        'outcomeAlarms': [
            {
                'alarmIdentifier': 'string',
                'type': 'CLOUDWATCH'
            },
        ]
    },
    'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}

Response Structure

  • (dict) –

    • arn (string) –

      The Amazon Resource Name (ARN) of the resource that you configured the practice run for.

    • name (string) –

      The name of the resource that you configured the practice run for.

    • practiceRunConfiguration (dict) –

      A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.

      • blockedDates (list) –

        An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.

        Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.

        • (string) –

      • blockedWindows (list) –

        An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.

        Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

        • (string) –

      • blockingAlarms (list) –

        The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

        • (dict) –

          A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. 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 or to interrupt a practice run in progress.

          Control condition alarms do not apply for autoshifts.

          For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

          • alarmIdentifier (string) –

            The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.

          • type (string) –

            The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.

      • outcomeAlarms (list) –

        The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.

        • (dict) –

          A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. 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 or to interrupt a practice run in progress.

          Control condition alarms do not apply for autoshifts.

          For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

          • alarmIdentifier (string) –

            The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.

          • type (string) –

            The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.

    • zonalAutoshiftStatus (string) –

      The status for zonal autoshift for a resource. When you specify ENABLED for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

      When you enable zonal autoshift, you must also configure practice runs for the resource.

Exceptions