1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. route53recoverycontrol
  5. getSafetyRule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.route53recoverycontrol.getSafetyRule

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource schema for AWS Route53 Recovery Control basic constructs and validation rules.

Using getSafetyRule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSafetyRule(args: GetSafetyRuleArgs, opts?: InvokeOptions): Promise<GetSafetyRuleResult>
function getSafetyRuleOutput(args: GetSafetyRuleOutputArgs, opts?: InvokeOptions): Output<GetSafetyRuleResult>
Copy
def get_safety_rule(safety_rule_arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSafetyRuleResult
def get_safety_rule_output(safety_rule_arn: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetSafetyRuleResult]
Copy
func LookupSafetyRule(ctx *Context, args *LookupSafetyRuleArgs, opts ...InvokeOption) (*LookupSafetyRuleResult, error)
func LookupSafetyRuleOutput(ctx *Context, args *LookupSafetyRuleOutputArgs, opts ...InvokeOption) LookupSafetyRuleResultOutput
Copy

> Note: This function is named LookupSafetyRule in the Go SDK.

public static class GetSafetyRule 
{
    public static Task<GetSafetyRuleResult> InvokeAsync(GetSafetyRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetSafetyRuleResult> Invoke(GetSafetyRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSafetyRuleResult> getSafetyRule(GetSafetyRuleArgs args, InvokeOptions options)
public static Output<GetSafetyRuleResult> getSafetyRule(GetSafetyRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:route53recoverycontrol:getSafetyRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

SafetyRuleArn This property is required. string
The Amazon Resource Name (ARN) of the safety rule.
SafetyRuleArn This property is required. string
The Amazon Resource Name (ARN) of the safety rule.
safetyRuleArn This property is required. String
The Amazon Resource Name (ARN) of the safety rule.
safetyRuleArn This property is required. string
The Amazon Resource Name (ARN) of the safety rule.
safety_rule_arn This property is required. str
The Amazon Resource Name (ARN) of the safety rule.
safetyRuleArn This property is required. String
The Amazon Resource Name (ARN) of the safety rule.

getSafetyRule Result

The following output properties are available:

AssertionRule Pulumi.AwsNative.Route53RecoveryControl.Outputs.SafetyRuleAssertionRule
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
ControlPanelArn string
The Amazon Resource Name (ARN) of the control panel.
GatingRule Pulumi.AwsNative.Route53RecoveryControl.Outputs.SafetyRuleGatingRule

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.

Name string
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
RuleConfig Pulumi.AwsNative.Route53RecoveryControl.Outputs.SafetyRuleRuleConfig
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 AWS Regions have traffic flowing to them.
SafetyRuleArn string
The Amazon Resource Name (ARN) of the safety rule.
Status Pulumi.AwsNative.Route53RecoveryControl.SafetyRuleStatus
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Tags List<Pulumi.AwsNative.Outputs.Tag>
A collection of tags associated with a resource
AssertionRule SafetyRuleAssertionRule
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
ControlPanelArn string
The Amazon Resource Name (ARN) of the control panel.
GatingRule SafetyRuleGatingRule

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.

Name string
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
RuleConfig SafetyRuleRuleConfig
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 AWS Regions have traffic flowing to them.
SafetyRuleArn string
The Amazon Resource Name (ARN) of the safety rule.
Status SafetyRuleStatus
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Tags Tag
A collection of tags associated with a resource
assertionRule SafetyRuleAssertionRule
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
controlPanelArn String
The Amazon Resource Name (ARN) of the control panel.
gatingRule SafetyRuleGatingRule

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.

name String
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
ruleConfig SafetyRuleRuleConfig
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 AWS Regions have traffic flowing to them.
safetyRuleArn String
The Amazon Resource Name (ARN) of the safety rule.
status SafetyRuleStatus
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
tags List<Tag>
A collection of tags associated with a resource
assertionRule SafetyRuleAssertionRule
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
controlPanelArn string
The Amazon Resource Name (ARN) of the control panel.
gatingRule SafetyRuleGatingRule

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.

name string
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
ruleConfig SafetyRuleRuleConfig
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 AWS Regions have traffic flowing to them.
safetyRuleArn string
The Amazon Resource Name (ARN) of the safety rule.
status SafetyRuleStatus
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
tags Tag[]
A collection of tags associated with a resource
assertion_rule SafetyRuleAssertionRule
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
control_panel_arn str
The Amazon Resource Name (ARN) of the control panel.
gating_rule SafetyRuleGatingRule

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.

name str
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
rule_config SafetyRuleRuleConfig
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 AWS Regions have traffic flowing to them.
safety_rule_arn str
The Amazon Resource Name (ARN) of the safety rule.
status SafetyRuleStatus
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
tags Sequence[root_Tag]
A collection of tags associated with a resource
assertionRule Property Map
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.
controlPanelArn String
The Amazon Resource Name (ARN) of the control panel.
gatingRule Property Map

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.

name String
The name of the assertion rule. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
ruleConfig Property Map
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 AWS Regions have traffic flowing to them.
safetyRuleArn String
The Amazon Resource Name (ARN) of the safety rule.
status "PENDING" | "DEPLOYED" | "PENDING_DELETION"
The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
tags List<Property Map>
A collection of tags associated with a resource

Supporting Types

SafetyRuleAssertionRule

AssertedControls This property is required. List<string>
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 AWS Regions.
WaitPeriodMs This property is required. int
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.
AssertedControls This property is required. []string
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 AWS Regions.
WaitPeriodMs This property is required. int
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.
assertedControls This property is required. List<String>
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 AWS Regions.
waitPeriodMs This property is required. 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.
assertedControls This property is required. string[]
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 AWS Regions.
waitPeriodMs This property is required. number
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.
asserted_controls This property is required. Sequence[str]
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 AWS Regions.
wait_period_ms This property is required. int
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.
assertedControls This property is required. List<String>
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 AWS Regions.
waitPeriodMs This property is required. Number
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.

SafetyRuleGatingRule

GatingControls This property is required. List<string>
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
TargetControls This property is required. List<string>
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 AWS 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.
WaitPeriodMs This property is required. int
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.
GatingControls This property is required. []string
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
TargetControls This property is required. []string
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 AWS 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.
WaitPeriodMs This property is required. int
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.
gatingControls This property is required. List<String>
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
targetControls This property is required. List<String>
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 AWS 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.
waitPeriodMs This property is required. 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.
gatingControls This property is required. string[]
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
targetControls This property is required. string[]
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 AWS 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.
waitPeriodMs This property is required. number
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_controls This property is required. Sequence[str]
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
target_controls This property is required. Sequence[str]
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 AWS 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.
wait_period_ms This property is required. int
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.
gatingControls This property is required. List<String>
The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
targetControls This property is required. List<String>
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 AWS 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.
waitPeriodMs This property is required. Number
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.

SafetyRuleRuleConfig

Inverted This property is required. bool
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold This property is required. int
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 This property is required. Pulumi.AwsNative.Route53RecoveryControl.SafetyRuleRuleType
A rule can be one of the following: ATLEAST , AND , or OR .
Inverted This property is required. bool
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Threshold This property is required. int
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 This property is required. SafetyRuleRuleType
A rule can be one of the following: ATLEAST , AND , or OR .
inverted This property is required. Boolean
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
threshold This property is required. 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 This property is required. SafetyRuleRuleType
A rule can be one of the following: ATLEAST , AND , or OR .
inverted This property is required. boolean
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
threshold This property is required. number
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 This property is required. SafetyRuleRuleType
A rule can be one of the following: ATLEAST , AND , or OR .
inverted This property is required. bool
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
threshold This property is required. int
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 This property is required. SafetyRuleRuleType
A rule can be one of the following: ATLEAST , AND , or OR .
inverted This property is required. Boolean
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
threshold This property is required. Number
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 This property is required. "AND" | "OR" | "ATLEAST"
A rule can be one of the following: ATLEAST , AND , or OR .

SafetyRuleRuleType

SafetyRuleStatus

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi