Package software.amazon.awssdk.services.waf.model

Interface WebACL.Builder

All Superinterfaces:

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

Enclosing class:

WebACL

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

Method Summary

Modifier and Type	Method	Description
default WebACL.Builder	defaultAction(Consumer<WafAction.Builder> defaultAction)	The action to perform if none of the Rules contained in the WebACL match.
WebACL.Builder	defaultAction(WafAction defaultAction)	The action to perform if none of the Rules contained in the WebACL match.
WebACL.Builder	metricName(String metricName)	A friendly name or description for the metrics for this WebACL.
WebACL.Builder	name(String name)	A friendly name or description of the WebACL.
WebACL.Builder	rules(Collection<ActivatedRule> rules)	An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
WebACL.Builder	rules(Consumer<ActivatedRule.Builder>... rules)	An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
WebACL.Builder	rules(ActivatedRule... rules)	An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
WebACL.Builder	webACLArn(String webACLArn)	Tha Amazon Resource Name (ARN) of the web ACL.
WebACL.Builder	webACLId(String webACLId)	A unique identifier for a WebACL.

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

webACLId

WebACL.Builder webACLId(String webACLId)

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Parameters:

webACLId - A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Returns:

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

name

WebACL.Builder name(String name)

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Parameters:

name - A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Returns:

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

metricName

WebACL.Builder metricName(String metricName)

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.

Parameters:

metricName - A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.

Returns:

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

defaultAction

WebACL.Builder defaultAction(WafAction defaultAction)

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Parameters:

defaultAction - The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Returns:

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

defaultAction

default WebACL.Builder defaultAction(Consumer<WafAction.Builder> defaultAction)

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

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

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

Parameters:

defaultAction - a consumer that will call methods on WafAction.Builder

Returns:

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

See Also:

defaultAction(WafAction)

rules

WebACL.Builder rules(Collection<ActivatedRule> rules)

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Parameters:

rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Returns:

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

rules

WebACL.Builder rules(ActivatedRule... rules)

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Parameters:

rules - An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Returns:

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

rules

WebACL.Builder rules(Consumer<ActivatedRule.Builder>... rules)

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #rules(List).

Parameters:

rules - a consumer that will call methods on ActivatedRule.Builder

Returns:

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

See Also:

#rules(java.util.Collection)

webACLArn

WebACL.Builder webACLArn(String webACLArn)

Tha Amazon Resource Name (ARN) of the web ACL.

Parameters:

webACLArn - Tha Amazon Resource Name (ARN) of the web ACL.

Returns:

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