Interface AssertionRule.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AssertionRule.Builder,AssertionRule>,SdkBuilder<AssertionRule.Builder,AssertionRule>,SdkPojo
- Enclosing class:
- AssertionRule
public static interface AssertionRule.Builder extends SdkPojo, CopyableBuilder<AssertionRule.Builder,AssertionRule>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AssertionRule.BuilderassertedControls(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.BuilderassertedControls(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.BuildercontrolPanelArn(String controlPanelArn)The Amazon Resource Name (ARN) of the control panel.AssertionRule.Buildername(String name)Name of the assertion rule.AssertionRule.Builderowner(String owner)The Amazon Web Services account ID of the assertion rule owner.default AssertionRule.BuilderruleConfig(Consumer<RuleConfig.Builder> 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.BuilderruleConfig(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.BuildersafetyRuleArn(String safetyRuleArn)The Amazon Resource Name (ARN) of the assertion rule.AssertionRule.Builderstatus(String status)The deployment status of an assertion rule.AssertionRule.Builderstatus(Status status)The deployment status of an assertion rule.AssertionRule.BuilderwaitPeriodMs(Integer waitPeriodMs)An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
assertedControls
AssertionRule.Builder assertedControls(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.
-
assertedControls
AssertionRule.Builder assertedControls(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.
-
controlPanelArn
AssertionRule.Builder controlPanelArn(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.
-
name
AssertionRule.Builder name(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.
-
ruleConfig
AssertionRule.Builder ruleConfig(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.
-
ruleConfig
default AssertionRule.Builder ruleConfig(Consumer<RuleConfig.Builder> 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.
This is a convenience method that creates an instance of theRuleConfig.Builderavoiding the need to create one manually viaRuleConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toruleConfig(RuleConfig).- Parameters:
ruleConfig- a consumer that will call methods onRuleConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ruleConfig(RuleConfig)
-
safetyRuleArn
AssertionRule.Builder safetyRuleArn(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.
-
status
AssertionRule.Builder status(String status)
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
-
status
AssertionRule.Builder status(Status status)
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
-
waitPeriodMs
AssertionRule.Builder waitPeriodMs(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.
-
owner
AssertionRule.Builder owner(String owner)
The Amazon Web Services account ID of the assertion rule owner.
- Parameters:
owner- The Amazon Web Services account ID of the assertion rule owner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-