AssertionRule (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssertionRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssertionRule()

Constructors
Constructor and Description
`AssertionRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssertionRule`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAssertedControls()` The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
`String`	`getControlPanelArn()` The Amazon Resource Name (ARN) of the control panel.
`String`	`getName()` Name of the assertion rule.
`RuleConfig`	`getRuleConfig()` 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.
`String`	`getSafetyRuleArn()` The Amazon Resource Name (ARN) of the assertion rule.
`String`	`getStatus()` The deployment status of an assertion rule.
`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`	`setAssertedControls(Collection<String> assertedControls)` The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
`void`	`setControlPanelArn(String controlPanelArn)` The Amazon Resource Name (ARN) of the control panel.
`void`	`setName(String name)` Name of the assertion rule.
`void`	`setRuleConfig(RuleConfig ruleConfig)` 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.
`void`	`setSafetyRuleArn(String safetyRuleArn)` The Amazon Resource Name (ARN) of the assertion rule.
`void`	`setStatus(String status)` The deployment status of an assertion rule.
`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.
`AssertionRule`	`withAssertedControls(Collection<String> assertedControls)` The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
`AssertionRule`	`withAssertedControls(String... assertedControls)` The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
`AssertionRule`	`withControlPanelArn(String controlPanelArn)` The Amazon Resource Name (ARN) of the control panel.
`AssertionRule`	`withName(String name)` Name of the assertion rule.
`AssertionRule`	`withRuleConfig(RuleConfig ruleConfig)` 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.
`AssertionRule`	`withSafetyRuleArn(String safetyRuleArn)` The Amazon Resource Name (ARN) of the assertion rule.
`AssertionRule`	`withStatus(Status status)` The deployment status of an assertion rule.
`AssertionRule`	`withStatus(String status)` The deployment status of an assertion rule.
`AssertionRule`	`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
  - AssertionRule
```
public AssertionRule()
```
- Method Detail
  - getAssertedControls
```
public List<String> getAssertedControls()
```
    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.
    
    Returns:
    
    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.
  - setAssertedControls
```
public void setAssertedControls(Collection<String> assertedControls)
```
    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.
    
    Parameters:
    
    assertedControls - 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.
  - withAssertedControls
```
public AssertionRule withAssertedControls(String... assertedControls)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAssertedControls(java.util.Collection) or withAssertedControls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    assertedControls - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAssertedControls
```
public AssertionRule withAssertedControls(Collection<String> assertedControls)
```
    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.
    
    Parameters:
    
    assertedControls - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 AssertionRule 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.
  - setName
```
public void setName(String name)
```
    Name of the assertion rule. You can use any non-white space character in the name.
    
    Parameters:
    
    name - Name of the assertion rule. You can use any non-white space character in the name.
  - getName
```
public String getName()
```
    Name of the assertion rule. You can use any non-white space character in the name.
    
    Returns:
    
    Name of the assertion rule. You can use any non-white space character in the name.
  - withName
```
public AssertionRule withName(String name)
```
    Name of the assertion rule. You can use any non-white space character in the name.
    
    Parameters:
    
    name - Name of the assertion rule. You can use any non-white space character in the name.
    
    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 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.
    
    Parameters:
    
    ruleConfig - 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.
  - getRuleConfig
```
public RuleConfig getRuleConfig()
```
    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.
    
    Returns:
    
    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.
  - withRuleConfig
```
public AssertionRule withRuleConfig(RuleConfig ruleConfig)
```
    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.
    
    Parameters:
    
    ruleConfig - 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.
    
    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 assertion rule.
    
    Parameters:
    
    safetyRuleArn - The Amazon Resource Name (ARN) of the assertion rule.
  - getSafetyRuleArn
```
public String getSafetyRuleArn()
```
    The Amazon Resource Name (ARN) of the assertion rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the assertion rule.
  - withSafetyRuleArn
```
public AssertionRule withSafetyRuleArn(String safetyRuleArn)
```
    The Amazon Resource Name (ARN) of the assertion rule.
    
    Parameters:
    
    safetyRuleArn - The Amazon Resource Name (ARN) of the assertion 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 an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Returns:
    
    The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    See Also:
    
    Status
  - withStatus
```
public AssertionRule withStatus(String status)
```
    The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of an assertion 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 AssertionRule withStatus(Status status)
```
    The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
    
    Parameters:
    
    status - The deployment status of an assertion 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
  - 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 AssertionRule 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 AssertionRule 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 AssertionRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssertionRule

Method Detail

getAssertedControls

setAssertedControls

withAssertedControls

withAssertedControls

setControlPanelArn

getControlPanelArn

withControlPanelArn

setName

getName

withName

setRuleConfig

getRuleConfig

withRuleConfig

setSafetyRuleArn

getSafetyRuleArn

withSafetyRuleArn

setStatus

getStatus

withStatus

withStatus

setWaitPeriodMs

getWaitPeriodMs

withWaitPeriodMs

toString

equals

hashCode

clone

marshall