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

Interface WebACL.Builder

All Superinterfaces:

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

Enclosing class:

WebACL

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

Method Summary

Modifier and Type	Method	Description
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(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	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

apply, build

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); the name can't contain whitespace. 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); the name can't contain whitespace. 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.

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.

NOTE: This method appends the values to the existing list (if any). Use #setRules(java.util.Collection) or #withRules(java.util.Collection) if you want to override the existing values.

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.