software.amazon.awssdk.services.wafv2.model

Interface DescribeManagedRuleGroupResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeManagedRuleGroupResponse.Builder,DescribeManagedRuleGroupResponse>, SdkBuilder<DescribeManagedRuleGroupResponse.Builder,DescribeManagedRuleGroupResponse>, SdkPojo, SdkResponse.Builder, Wafv2Response.Builder

Enclosing class:

DescribeManagedRuleGroupResponse

public static interface DescribeManagedRuleGroupResponse.Builder
extends Wafv2Response.Builder, SdkPojo, CopyableBuilder<DescribeManagedRuleGroupResponse.Builder,DescribeManagedRuleGroupResponse>

Method Summary

Modifier and Type	Method and Description
DescribeManagedRuleGroupResponse.Builder	availableLabels(Collection<LabelSummary> availableLabels) The labels that one or more rules in this rule group add to matching web requests.
DescribeManagedRuleGroupResponse.Builder	availableLabels(Consumer<LabelSummary.Builder>... availableLabels) The labels that one or more rules in this rule group add to matching web requests.
DescribeManagedRuleGroupResponse.Builder	availableLabels(LabelSummary... availableLabels) The labels that one or more rules in this rule group add to matching web requests.
DescribeManagedRuleGroupResponse.Builder	capacity(Long capacity) The web ACL capacity units (WCUs) required for this rule group.
DescribeManagedRuleGroupResponse.Builder	consumedLabels(Collection<LabelSummary> consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
DescribeManagedRuleGroupResponse.Builder	consumedLabels(Consumer<LabelSummary.Builder>... consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
DescribeManagedRuleGroupResponse.Builder	consumedLabels(LabelSummary... consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
DescribeManagedRuleGroupResponse.Builder	labelNamespace(String labelNamespace) The label namespace prefix for this rule group.
DescribeManagedRuleGroupResponse.Builder	rules(Collection<RuleSummary> rules)
DescribeManagedRuleGroupResponse.Builder	rules(Consumer<RuleSummary.Builder>... rules) This is a convenience method that creates an instance of the RuleSummary.Builder avoiding the need to create one manually via RuleSummary.builder().
DescribeManagedRuleGroupResponse.Builder	rules(RuleSummary... rules)
DescribeManagedRuleGroupResponse.Builder	snsTopicArn(String snsTopicArn) The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group.
DescribeManagedRuleGroupResponse.Builder	versionName(String versionName) The managed rule group's version.

Methods inherited from interface software.amazon.awssdk.services.wafv2.model.Wafv2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

versionName

DescribeManagedRuleGroupResponse.Builder versionName(String versionName)

The managed rule group's version.

Parameters:

versionName - The managed rule group's version.

Returns:

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

snsTopicArn

DescribeManagedRuleGroupResponse.Builder snsTopicArn(String snsTopicArn)

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

Parameters:

snsTopicArn - The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

Returns:

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

capacity

DescribeManagedRuleGroupResponse.Builder capacity(Long capacity)

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

Parameters:

capacity - The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

Returns:

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

rules

DescribeManagedRuleGroupResponse.Builder rules(Collection<RuleSummary> rules)

Parameters:

rules -

Returns:

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

rules

DescribeManagedRuleGroupResponse.Builder rules(RuleSummary... rules)

Parameters:

rules -

Returns:

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

rules

DescribeManagedRuleGroupResponse.Builder rules(Consumer<RuleSummary.Builder>... rules)

This is a convenience method that creates an instance of the RuleSummary.Builder avoiding the need to create one manually via RuleSummary.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 RuleSummary.Builder

Returns:

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

See Also:

#rules(java.util.Collection)

labelNamespace

DescribeManagedRuleGroupResponse.Builder labelNamespace(String labelNamespace)

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Parameters:

labelNamespace - The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Returns:

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

availableLabels

DescribeManagedRuleGroupResponse.Builder availableLabels(Collection<LabelSummary> availableLabels)

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

Parameters:

availableLabels - The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

Returns:

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

availableLabels

DescribeManagedRuleGroupResponse.Builder availableLabels(LabelSummary... availableLabels)

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

Parameters:

availableLabels - The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

Returns:

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

availableLabels

DescribeManagedRuleGroupResponse.Builder availableLabels(Consumer<LabelSummary.Builder>... availableLabels)

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

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

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

Parameters:

availableLabels - a consumer that will call methods on LabelSummary.Builder

Returns:

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

See Also:

#availableLabels(java.util.Collection)

consumedLabels

DescribeManagedRuleGroupResponse.Builder consumedLabels(Collection<LabelSummary> consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Parameters:

consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Returns:

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

consumedLabels

DescribeManagedRuleGroupResponse.Builder consumedLabels(LabelSummary... consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Parameters:

consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Returns:

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

consumedLabels

DescribeManagedRuleGroupResponse.Builder consumedLabels(Consumer<LabelSummary.Builder>... consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

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

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

Parameters:

consumedLabels - a consumer that will call methods on LabelSummary.Builder

Returns:

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

See Also:

#consumedLabels(java.util.Collection)