software.amazon.awssdk.services.route53recoverycontrolconfig.model

Interface NewGatingRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<NewGatingRule.Builder,NewGatingRule>, SdkBuilder<NewGatingRule.Builder,NewGatingRule>, SdkPojo

Enclosing class:

NewGatingRule

public static interface NewGatingRule.Builder
extends SdkPojo, CopyableBuilder<NewGatingRule.Builder,NewGatingRule>

Method Summary

Modifier and Type	Method and Description
NewGatingRule.Builder	controlPanelArn(String controlPanelArn) The Amazon Resource Name (ARN) of the control panel.
NewGatingRule.Builder	gatingControls(Collection<String> gatingControls) The gating controls for the new gating rule.
NewGatingRule.Builder	gatingControls(String... gatingControls) The gating controls for the new gating rule.
NewGatingRule.Builder	name(String name) The name for the new gating rule.
default NewGatingRule.Builder	ruleConfig(Consumer<RuleConfig.Builder> ruleConfig) The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
NewGatingRule.Builder	ruleConfig(RuleConfig ruleConfig) The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
NewGatingRule.Builder	targetControls(Collection<String> targetControls) Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
NewGatingRule.Builder	targetControls(String... targetControls) Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
NewGatingRule.Builder	waitPeriodMs(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.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

controlPanelArn

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

gatingControls

NewGatingRule.Builder gatingControls(Collection<String> gatingControls)

The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

Parameters:

gatingControls - The gating controls for the new 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.

gatingControls

NewGatingRule.Builder gatingControls(String... gatingControls)

The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

Parameters:

gatingControls - The gating controls for the new 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.

name

NewGatingRule.Builder name(String name)

The name for the new gating rule.

Parameters:

name - The name for the new gating rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleConfig

NewGatingRule.Builder ruleConfig(RuleConfig ruleConfig)

The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.

Parameters:

ruleConfig - The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleConfig

default NewGatingRule.Builder ruleConfig(Consumer<RuleConfig.Builder> ruleConfig)

The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.

This is a convenience method that creates an instance of the RuleConfig.Builder avoiding the need to create one manually via RuleConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleConfig(RuleConfig).

Parameters:

ruleConfig - a consumer that will call methods on RuleConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ruleConfig(RuleConfig)

targetControls

NewGatingRule.Builder targetControls(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.

targetControls

NewGatingRule.Builder targetControls(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.

waitPeriodMs

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