We recommend new projects start with resources from the AWS provider.
aws-native.route53recoverycontrol.getSafetyRule
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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>
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]
func LookupSafetyRule(ctx *Context, args *LookupSafetyRuleArgs, opts ...InvokeOption) (*LookupSafetyRuleResult, error)
func LookupSafetyRuleOutput(ctx *Context, args *LookupSafetyRuleOutputArgs, opts ...InvokeOption) LookupSafetyRuleResultOutput
> 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)
}
public static CompletableFuture<GetSafetyRuleResult> getSafetyRule(GetSafetyRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:route53recoverycontrol:getSafetyRule
arguments:
# arguments dictionary
The following arguments are supported:
- Safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- Safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- safety
Rule StringArn - The Amazon Resource Name (ARN) of the safety rule.
- safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- safety_
rule_ strarn - The Amazon Resource Name (ARN) of the safety rule.
- safety
Rule StringArn - The Amazon Resource Name (ARN) of the safety rule.
getSafetyRule Result
The following output properties are available:
- Assertion
Rule Pulumi.Aws Native. Route53Recovery Control. Outputs. Safety Rule Assertion Rule - 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 stringArn - The Amazon Resource Name (ARN) of the control panel.
- Gating
Rule Pulumi.Aws Native. Route53Recovery Control. Outputs. Safety Rule Gating Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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)
- Rule
Config Pulumi.Aws Native. Route53Recovery Control. Outputs. Safety Rule Rule Config - 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - Safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- Status
Pulumi.
Aws Native. Route53Recovery Control. Safety Rule Status - The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- List<Pulumi.
Aws Native. Outputs. Tag> - A collection of tags associated with a resource
- Assertion
Rule SafetyRule Assertion Rule - 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 stringArn - The Amazon Resource Name (ARN) of the control panel.
- Gating
Rule SafetyRule Gating Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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)
- Rule
Config SafetyRule Rule Config - 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - Safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- Status
Safety
Rule Status - The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- Tag
- A collection of tags associated with a resource
- assertion
Rule SafetyRule Assertion Rule - 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 StringArn - The Amazon Resource Name (ARN) of the control panel.
- gating
Rule SafetyRule Gating Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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)
- rule
Config SafetyRule Rule Config - 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - safety
Rule StringArn - The Amazon Resource Name (ARN) of the safety rule.
- status
Safety
Rule Status - The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- List<Tag>
- A collection of tags associated with a resource
- assertion
Rule SafetyRule Assertion Rule - 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 stringArn - The Amazon Resource Name (ARN) of the control panel.
- gating
Rule SafetyRule Gating Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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)
- rule
Config SafetyRule Rule Config - 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - safety
Rule stringArn - The Amazon Resource Name (ARN) of the safety rule.
- status
Safety
Rule Status - The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- Tag[]
- A collection of tags associated with a resource
- assertion_
rule SafetyRule Assertion Rule - 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_ strarn - The Amazon Resource Name (ARN) of the control panel.
- gating_
rule SafetyRule Gating Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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 SafetyRule Rule Config - 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - safety_
rule_ strarn - The Amazon Resource Name (ARN) of the safety rule.
- status
Safety
Rule Status - The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- Sequence[root_Tag]
- A collection of tags associated with a resource
- assertion
Rule 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. - control
Panel StringArn - The Amazon Resource Name (ARN) of the control panel.
- gating
Rule 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 toOR
, that indicates that you must set the gating routing control toOn
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)
- rule
Config 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 specifyATLEAST 2
for your rule configuration. This means that at least two assertion controls must beON
, so that at least two AWS Regions have traffic flowing to them. - safety
Rule StringArn - 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.
- List<Property Map>
- A collection of tags associated with a resource
Supporting Types
SafetyRuleAssertionRule
- Asserted
Controls 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.
- Wait
Period intMs - 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 []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.
- Wait
Period intMs - 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 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.
- wait
Period IntegerMs - 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 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.
- wait
Period numberMs - 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 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_ intms - 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 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.
- wait
Period NumberMs - 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
- Gating
Controls List<string> - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- Target
Controls 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.
- Wait
Period intMs - 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 []string - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- Target
Controls []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.
- Wait
Period intMs - 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 List<String> - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- target
Controls 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.
- wait
Period IntegerMs - 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 string[] - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- target
Controls 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.
- wait
Period numberMs - 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 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 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_ intms - 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 List<String> - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- target
Controls 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.
- wait
Period NumberMs - 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 bool
- Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- Threshold 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
Pulumi.
Aws Native. Route53Recovery Control. Safety Rule Rule Type - A rule can be one of the following:
ATLEAST
,AND
, orOR
.
- Inverted bool
- Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- Threshold 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
Safety
Rule Rule Type - A rule can be one of the following:
ATLEAST
,AND
, orOR
.
- 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
Safety
Rule Rule Type - A rule can be one of the following:
ATLEAST
,AND
, orOR
.
- inverted boolean
- Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- threshold 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
Safety
Rule Rule Type - A rule can be one of the following:
ATLEAST
,AND
, orOR
.
- inverted bool
- Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- threshold 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
Safety
Rule Rule Type - A rule can be one of the following:
ATLEAST
,AND
, orOR
.
- inverted Boolean
- Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- threshold 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 "AND" | "OR" | "ATLEAST"
- A rule can be one of the following:
ATLEAST
,AND
, orOR
.
SafetyRuleRuleType
SafetyRuleStatus
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.