GatingRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.route53recoverycontrolconfig.model.GatingRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GatingRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GatingRule()

Constructors
Constructor and Description
`GatingRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GatingRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getControlPanelArn()` The Amazon Resource Name (ARN) of the control panel.
`List<String>`	`getGatingControls()` The gating controls for the gating rule.
`String`	`getName()` The name for the gating rule.
`RuleConfig`	`getRuleConfig()` The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
`String`	`getSafetyRuleArn()` The Amazon Resource Name (ARN) of the gating rule.
`String`	`getStatus()` The deployment status of a gating rule.
`List<String>`	`getTargetControls()` Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
`Integer`	`getWaitPeriodMs()` An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setControlPanelArn(String controlPanelArn)` The Amazon Resource Name (ARN) of the control panel.
`void`	`setGatingControls(Collection<String> gatingControls)` The gating controls for the gating rule.
`void`	`setName(String name)` The name for the gating rule.
`void`	`setRuleConfig(RuleConfig ruleConfig)` The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
`void`	`setSafetyRuleArn(String safetyRuleArn)` The Amazon Resource Name (ARN) of the gating rule.
`void`	`setStatus(String status)` The deployment status of a gating rule.
`void`	`setTargetControls(Collection<String> targetControls)` Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
`void`	`setWaitPeriodMs(Integer waitPeriodMs)` An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.
`String`	`toString()` Returns a string representation of this object.
`GatingRule`	`withControlPanelArn(String controlPanelArn)` The Amazon Resource Name (ARN) of the control panel.
`GatingRule`	`withGatingControls(Collection<String> gatingControls)` The gating controls for the gating rule.
`GatingRule`	`withGatingControls(String... gatingControls)` The gating controls for the gating rule.
`GatingRule`	`withName(String name)` The name for the gating rule.
`GatingRule`	`withRuleConfig(RuleConfig ruleConfig)` The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
`GatingRule`	`withSafetyRuleArn(String safetyRuleArn)` The Amazon Resource Name (ARN) of the gating rule.
`GatingRule`	`withStatus(Status status)` The deployment status of a gating rule.
`GatingRule`	`withStatus(String status)` The deployment status of a gating rule.
`GatingRule`	`withTargetControls(Collection<String> targetControls)` Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
`GatingRule`	`withTargetControls(String... targetControls)` Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
`GatingRule`	`withWaitPeriodMs(Integer waitPeriodMs)` An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GatingRule
```
public GatingRule()
```
- Method Detail
  - setControlPanelArn
```
public void setControlPanelArn(String controlPanelArn)
```
    The Amazon Resource Name (ARN) of the control panel.
    
    Parameters:
    
    controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
  - getControlPanelArn
```
public String getControlPanelArn()
```
    The Amazon Resource Name (ARN) of the control panel.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the control panel.
  - withControlPanelArn
```
public GatingRule withControlPanelArn(String controlPanelArn)
```
    The Amazon Resource Name (ARN) of the control panel.
    
    Parameters:
    
    controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGatingControls
```
public List<String> getGatingControls()
```
    The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    Returns:
    
    The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
  - setGatingControls
```
public void setGatingControls(Collection<String> gatingControls)
```
    The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    Parameters:
    
    gatingControls - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
  - withGatingControls
```
public GatingRule withGatingControls(String... gatingControls)
```
    The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    NOTE: This method appends the values to the existing list (if any). Use setGatingControls(java.util.Collection) or withGatingControls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    gatingControls - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGatingControls
```
public GatingRule withGatingControls(Collection<String> gatingControls)
```
    The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    Parameters:
    
    gatingControls - The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name for the gating rule.
    
    Parameters:
    
    name - The name for the gating rule.
  - getName
```
public String getName()
```
    The name for the gating rule.
    
    Returns:
    
    The name for the gating rule.
  - withName
```
public GatingRule withName(String name)
```
    The name for the gating rule.
    
    Parameters:
    
    name - The name for the gating rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleConfig
```
public void setRuleConfig(RuleConfig ruleConfig)
```
    The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
    
    Parameters:
    
    ruleConfig - The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
  - getRuleConfig
```
public RuleConfig getRuleConfig()
```
    The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
    
    Returns:
    
    The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
  - withRuleConfig
```
public GatingRule withRuleConfig(RuleConfig ruleConfig)
```
    The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
    
    Parameters:
    
    ruleConfig - The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSafetyRuleArn
```
public void setSafetyRuleArn(String safetyRuleArn)
```
    The Amazon Resource Name (ARN) of the gating rule.
    
    Parameters:
    
    safetyRuleArn - The Amazon Resource Name (ARN) of the gating rule.
  - getSafetyRuleArn
```
public String getSafetyRuleArn()
```
    The Amazon Resource Name (ARN) of the gating rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the gating rule.
  - withSafetyRuleArn
```
public GatingRule withSafetyRuleArn(String safetyRuleArn)
```
    The Amazon Resource Name (ARN) of the gating rule.
    
    Parameters:
    
    safetyRuleArn - The Amazon Resource Name (ARN) of the gating rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Returns:
    
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    See Also:
    
    Status
  - withStatus
```
public GatingRule withStatus(String status)
```
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
public GatingRule withStatus(Status status)
```
    The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - getTargetControls
```
public List<String> getTargetControls()
```
    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.
    
    Returns:
    
    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.
  - setTargetControls
```
public void setTargetControls(Collection<String> targetControls)
```
    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.
    
    Parameters:
    
    targetControls - 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.
  - withTargetControls
```
public GatingRule withTargetControls(String... targetControls)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargetControls(java.util.Collection) or withTargetControls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targetControls - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetControls
```
public GatingRule withTargetControls(Collection<String> targetControls)
```
    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.
    
    Parameters:
    
    targetControls - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWaitPeriodMs
```
public void setWaitPeriodMs(Integer waitPeriodMs)
```
    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.
    
    Parameters:
    
    waitPeriodMs - 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.
  - getWaitPeriodMs
```
public Integer getWaitPeriodMs()
```
    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.
    
    Returns:
    
    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.
  - withWaitPeriodMs
```
public GatingRule withWaitPeriodMs(Integer waitPeriodMs)
```
    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.
    
    Parameters:
    
    waitPeriodMs - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GatingRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GatingRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatingRule

Method Detail

setControlPanelArn

getControlPanelArn

withControlPanelArn

getGatingControls

setGatingControls

withGatingControls

withGatingControls

setName

getName

withName

setRuleConfig

getRuleConfig

withRuleConfig

setSafetyRuleArn

getSafetyRuleArn

withSafetyRuleArn

setStatus

getStatus

withStatus

withStatus

getTargetControls

setTargetControls

withTargetControls

withTargetControls

setWaitPeriodMs

getWaitPeriodMs

withWaitPeriodMs

toString

equals

hashCode

clone

marshall