Route53RecoveryControlConfig / Client / create_safety_rule

create_safety_rule#

Route53RecoveryControlConfig.Client.create_safety_rule(**kwargs)#

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall “on/off” switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

Request Syntax

response = client.create_safety_rule(
    AssertionRule={
        'AssertedControls': [
            'string',
        ],
        'ControlPanelArn': 'string',
        'Name': 'string',
        'RuleConfig': {
            'Inverted': True|False,
            'Threshold': 123,
            'Type': 'ATLEAST'|'AND'|'OR'
        },
        'WaitPeriodMs': 123
    },
    ClientToken='string',
    GatingRule={
        'ControlPanelArn': 'string',
        'GatingControls': [
            'string',
        ],
        'Name': 'string',
        'RuleConfig': {
            'Inverted': True|False,
            'Threshold': 123,
            'Type': 'ATLEAST'|'AND'|'OR'
        },
        'TargetControls': [
            'string',
        ],
        'WaitPeriodMs': 123
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

AssertionRule (dict) –
The assertion rule requested.
- AssertedControls (list) – [REQUIRED]
  
  The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
  - (string) –
- ControlPanelArn (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) for the control panel.
- Name (string) – [REQUIRED]
  
  The name of the assertion rule. You can use any non-white space character in the name.
- RuleConfig (dict) – [REQUIRED]
  
  The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
  - Inverted (boolean) – [REQUIRED]
    
    Logical negation of the rule. If the rule would usually evaluate true, it’s evaluated as false, and vice versa.
  - Threshold (integer) – [REQUIRED]
    
    The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
  - Type (string) – [REQUIRED]
    
    A rule can be one of the following: ATLEAST, AND, or OR.
- WaitPeriodMs (integer) – [REQUIRED]
  
  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.
ClientToken (string) –
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

This field is autopopulated if not provided.
GatingRule (dict) –
The gating rule requested.
- ControlPanelArn (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) of the control panel.
- GatingControls (list) – [REQUIRED]
  
  The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
  - (string) –
- Name (string) – [REQUIRED]
  
  The name for the new gating rule.
- RuleConfig (dict) – [REQUIRED]
  
  The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
  - Inverted (boolean) – [REQUIRED]
    
    Logical negation of the rule. If the rule would usually evaluate true, it’s evaluated as false, and vice versa.
  - Threshold (integer) – [REQUIRED]
    
    The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
  - Type (string) – [REQUIRED]
    
    A rule can be one of the following: ATLEAST, AND, or OR.
- TargetControls (list) – [REQUIRED]
  
  Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
  
  In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
  - (string) –
- WaitPeriodMs (integer) – [REQUIRED]
  
  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.
Tags (dict) –
The tags associated with the safety rule.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AssertionRule': {
        'AssertedControls': [
            'string',
        ],
        'ControlPanelArn': 'string',
        'Name': 'string',
        'RuleConfig': {
            'Inverted': True|False,
            'Threshold': 123,
            'Type': 'ATLEAST'|'AND'|'OR'
        },
        'SafetyRuleArn': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'WaitPeriodMs': 123,
        'Owner': 'string'
    },
    'GatingRule': {
        'ControlPanelArn': 'string',
        'GatingControls': [
            'string',
        ],
        'Name': 'string',
        'RuleConfig': {
            'Inverted': True|False,
            'Threshold': 123,
            'Type': 'ATLEAST'|'AND'|'OR'
        },
        'SafetyRuleArn': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'TargetControls': [
            'string',
        ],
        'WaitPeriodMs': 123,
        'Owner': 'string'
    }
}

Response Structure

(dict) –

200 response - Success.
- AssertionRule (dict) –
  
  The assertion rule created.
  - AssertedControls (list) –
    
    The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
    - (string) –
  - ControlPanelArn (string) –
    
    The Amazon Resource Name (ARN) of the control panel.
  - Name (string) –
    
    Name of the assertion rule. You can use any non-white space character in the name.
  - RuleConfig (dict) –
    
    The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
    - Inverted (boolean) –
      
      Logical negation of the rule. If the rule would usually evaluate true, it’s evaluated as false, and vice versa.
    - Threshold (integer) –
      
      The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
    - Type (string) –
      
      A rule can be one of the following: ATLEAST, AND, or OR.
  - SafetyRuleArn (string) –
    
    The Amazon Resource Name (ARN) of the assertion rule.
  - Status (string) –
    
    The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  - WaitPeriodMs (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.
  - Owner (string) –
    
    The Amazon Web Services account ID of the assertion rule owner.
- GatingRule (dict) –
  
  The gating rule created.
  - ControlPanelArn (string) –
    
    The Amazon Resource Name (ARN) of the control panel.
  - GatingControls (list) –
    
    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.
    - (string) –
  - Name (string) –
    
    The name for the gating rule. You can use any non-white space character in the name.
  - RuleConfig (dict) –
    
    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.
    - Inverted (boolean) –
      
      Logical negation of the rule. If the rule would usually evaluate true, it’s evaluated as false, and vice versa.
    - Threshold (integer) –
      
      The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
    - Type (string) –
      
      A rule can be one of the following: ATLEAST, AND, or OR.
  - SafetyRuleArn (string) –
    
    The Amazon Resource Name (ARN) of the gating rule.
  - Status (string) –
    
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  - TargetControls (list) –
    
    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.
    - (string) –
  - WaitPeriodMs (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.
  - Owner (string) –
    
    The Amazon Web Services account ID of the gating rule owner.

create_safety_rule#

Request Syntax

Response Syntax

Response Structure

Exceptions