AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Route53 Recovery Control Config CreateSafetyRule API operation.

Syntax

New-R53RCSafetyRule
-AssertionRule_AssertedControl <String[]>
-AssertionRule_ControlPanelArn <String>
-GatingRule_ControlPanelArn <String>
-GatingRule_GatingControl <String[]>
-AssertionRule_RuleConfig_Inverted <Boolean>
-GatingRule_RuleConfig_Inverted <Boolean>
-AssertionRule_Name <String>
-GatingRule_Name <String>
-Tag <Hashtable>
-GatingRule_TargetControl <String[]>
-AssertionRule_RuleConfig_Threshold <Int32>
-GatingRule_RuleConfig_Threshold <Int32>
-AssertionRule_RuleConfig_Type <RuleType>
-GatingRule_RuleConfig_Type <RuleType>
-AssertionRule_WaitPeriodMs <Int32>
-GatingRule_WaitPeriodMs <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>

Description

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 transation 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.

Parameters

-AssertionRule_AssertedControl <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 Amazon Web Services Regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAssertionRule_AssertedControls
-AssertionRule_ControlPanelArn <String>
The Amazon Resource Name (ARN) for the control panel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssertionRule_Name <String>
The name of the assertion rule. You can use any non-white space character in the name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssertionRule_RuleConfig_Inverted <Boolean>
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssertionRule_RuleConfig_Threshold <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssertionRule_RuleConfig_Type <RuleType>
A rule can be one of the following: ATLEAST, AND, or OR.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssertionRule_WaitPeriodMs <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_ControlPanelArn <String>
The Amazon Resource Name (ARN) of the control panel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_GatingControl <String[]>
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGatingRule_GatingControls
-GatingRule_Name <String>
The name for the new gating rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_RuleConfig_Inverted <Boolean>
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_RuleConfig_Threshold <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_RuleConfig_Type <RuleType>
A rule can be one of the following: ATLEAST, AND, or OR.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatingRule_TargetControl <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 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGatingRule_TargetControls
-GatingRule_WaitPeriodMs <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.CreateSafetyRuleResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.CreateSafetyRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags associated with the safety rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.Route53RecoveryControlConfig.Model.CreateSafetyRuleResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z