Skip to content
AWS for Query.Farm

aws.route53_recovery_control_config.list_safety_rules

Example SQL Queries

SELECT * FROM
aws.route53_recovery_control_config.list_safety_rules
WHERE
"control_panel_arn" = 'VALUE';

Description

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

Table Definition

Column NameColumn Data Type
control_panel_arn Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
assertion

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. 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.

STRUCT(
    "asserted_controls" VARCHAR[],
    "control_panel_arn" VARCHAR,
    "name" VARCHAR,
    "rule_config" STRUCT(
        "inverted" BOOLEAN,
        "threshold" BIGINT,
        "type" VARCHAR
    ),
    "safety_rule_arn" VARCHAR,
    "status" VARCHAR,
    "wait_period_ms" BIGINT,
    "owner" VARCHAR
)
Show child fields
assertion.asserted_controls[]
assertion.control_panel_arn

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

assertion.name

Name of the assertion rule. You can use any non-white space character in the name.

assertion.owner

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

assertion.rule_config

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.

Show child fields
assertion.rule_config.inverted

Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

assertion.rule_config.threshold

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.

assertion.rule_config.type

A rule can be one of the following: ATLEAST, AND, or OR.

assertion.safety_rule_arn

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

assertion.status

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

assertion.wait_period_ms

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.

gating

A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

STRUCT(
    "control_panel_arn" VARCHAR,
    "gating_controls" VARCHAR[],
    "name" VARCHAR,
    "rule_config" STRUCT(
        "inverted" BOOLEAN,
        "threshold" BIGINT,
        "type" VARCHAR
    ),
    "safety_rule_arn" VARCHAR,
    "status" VARCHAR,
    "target_controls" VARCHAR[],
    "wait_period_ms" BIGINT,
    "owner" VARCHAR
)
Show child fields
gating.control_panel_arn

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

gating.gating_controls[]
gating.name

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

gating.owner

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

gating.rule_config

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.

Show child fields
gating.rule_config.inverted

Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

gating.rule_config.threshold

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.

gating.rule_config.type

A rule can be one of the following: ATLEAST, AND, or OR.

gating.safety_rule_arn

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

gating.status

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

gating.target_controls[]
gating.wait_period_ms

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.