Package software.amazon.awssdk.services.route53recoverycontrolconfig.model

Interface GatingRule.Builder

All Superinterfaces:

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

Enclosing class:

GatingRule

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

Method Summary

Modifier and Type	Method	Description
GatingRule.Builder	controlPanelArn(String controlPanelArn)	The Amazon Resource Name (ARN) of the control panel.
GatingRule.Builder	gatingControls(String... gatingControls)	An array of gating routing control Amazon Resource Names (ARNs).
GatingRule.Builder	gatingControls(Collection<String> gatingControls)	An array of gating routing control Amazon Resource Names (ARNs).
GatingRule.Builder	name(String name)	The name for the gating rule.
GatingRule.Builder	owner(String owner)	The Amazon Web Services account ID of the gating rule owner.
default GatingRule.Builder	ruleConfig(Consumer<RuleConfig.Builder> ruleConfig)	The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
GatingRule.Builder	ruleConfig(RuleConfig ruleConfig)	The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
GatingRule.Builder	safetyRuleArn(String safetyRuleArn)	The Amazon Resource Name (ARN) of the gating rule.
GatingRule.Builder	status(String status)	The deployment status of a gating rule.
GatingRule.Builder	status(Status status)	The deployment status of a gating rule.
GatingRule.Builder	targetControls(String... targetControls)	An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control.
GatingRule.Builder	targetControls(Collection<String> targetControls)	An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control.
GatingRule.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.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

controlPanelArn

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

GatingRule.Builder gatingControls(Collection<String> gatingControls)

An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

Parameters:

gatingControls - An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

Returns:

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

gatingControls

GatingRule.Builder gatingControls(String... gatingControls)

An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

Parameters:

gatingControls - An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

Returns:

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

name

GatingRule.Builder name(String name)

The name for the gating rule. You can use any non-white space character in the name.

Parameters:

name - The name for the gating 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

GatingRule.Builder ruleConfig(RuleConfig ruleConfig)

The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.

Parameters:

ruleConfig - The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.

Returns:

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

ruleConfig

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

The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing 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)

safetyRuleArn

GatingRule.Builder safetyRuleArn(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.

status

GatingRule.Builder status(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, Status

status

GatingRule.Builder status(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, Status

targetControls

GatingRule.Builder targetControls(Collection<String> targetControls)

An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.

Parameters:

targetControls - An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.

Returns:

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

targetControls

GatingRule.Builder targetControls(String... targetControls)

An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.

Parameters:

targetControls - An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.

Returns:

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

waitPeriodMs

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

GatingRule.Builder owner(String owner)

The Amazon Web Services account ID of the gating rule owner.

Parameters:

owner - The Amazon Web Services account ID of the gating rule owner.

Returns:

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