Skip to content

GatingRule

Source code in docs_src/capo_route53_recovery_control_config/types/gating_rule.py
class GatingRule(TypedDict, closed=True):
    control_panel_arn: NotRequired[
        "capo_route53_recovery_control_config.types.__string_min1_max256_pattern_a_za_z09.__stringMin1Max256PatternAZaZ09"
    ]
    """<p>The Amazon Resource Name (ARN) of the control panel.</p>"""
    gating_controls: NotRequired[
        "capo_route53_recovery_control_config.types.__list_of__string_min1_max256_pattern_a_za_z09.__listOf__stringMin1Max256PatternAZaZ09"
    ]
    """<p>An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.</p>"""
    name: NotRequired[
        "capo_route53_recovery_control_config.types.__string_min1_max64_pattern_s.__stringMin1Max64PatternS"
    ]
    """<p>The name for the gating rule. You can use any non-white space character in the name.</p>"""
    rule_config: NotRequired[
        "capo_route53_recovery_control_config.types.rule_config.RuleConfig"
    ]
    """<p>The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.</p>"""
    safety_rule_arn: NotRequired[
        "capo_route53_recovery_control_config.types.__string_min1_max256_pattern_a_za_z09.__stringMin1Max256PatternAZaZ09"
    ]
    """<p>The Amazon Resource Name (ARN) of the gating rule.</p>"""
    status: NotRequired["capo_route53_recovery_control_config.types.status.Status"]
    """<p>The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.</p>"""
    target_controls: NotRequired[
        "capo_route53_recovery_control_config.types.__list_of__string_min1_max256_pattern_a_za_z09.__listOf__stringMin1Max256PatternAZaZ09"
    ]
    """<p>An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.</p>"""
    wait_period_ms: NotRequired[
        "capo_route53_recovery_control_config.types.__integer.__integer"
    ]
    """<p>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</p>"""
    owner: NotRequired[
        "capo_route53_recovery_control_config.types.__string_min12_max12_pattern_d12.__stringMin12Max12PatternD12"
    ]
    """<p>The Amazon Web Services account ID of the gating rule owner.</p>"""

control_panel_arn instance-attribute

control_panel_arn: NotRequired[__stringMin1Max256PatternAZaZ09]

The Amazon Resource Name (ARN) of the control panel.

gating_controls instance-attribute

gating_controls: NotRequired[__listOf__stringMin1Max256PatternAZaZ09]

An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

name instance-attribute

name: NotRequired[__stringMin1Max64PatternS]

The name for the gating rule. You can use any non-white space character in the name.

owner instance-attribute

owner: NotRequired[__stringMin12Max12PatternD12]

The Amazon Web Services account ID of the gating rule owner.

rule_config instance-attribute

rule_config: NotRequired[RuleConfig]

The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.

safety_rule_arn instance-attribute

safety_rule_arn: NotRequired[__stringMin1Max256PatternAZaZ09]

The Amazon Resource Name (ARN) of the gating rule.

status instance-attribute

status: NotRequired[Status]

The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

target_controls instance-attribute

target_controls: NotRequired[__listOf__stringMin1Max256PatternAZaZ09]

An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.

wait_period_ms instance-attribute

wait_period_ms: NotRequired[__integer]

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.