Package software.amazon.awssdk.services.securityhub.model

Interface AwsWafv2RuleGroupDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsWafv2RuleGroupDetails

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

Method Summary

Modifier and Type	Method	Description
AwsWafv2RuleGroupDetails.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the entity.
AwsWafv2RuleGroupDetails.Builder	capacity(Long capacity)	The web ACL capacity units (WCUs) required for this rule group.
AwsWafv2RuleGroupDetails.Builder	description(String description)	A description of the rule group that helps with identification.
AwsWafv2RuleGroupDetails.Builder	id(String id)	A unique identifier for the rule group.
AwsWafv2RuleGroupDetails.Builder	name(String name)	The name of the rule group.
AwsWafv2RuleGroupDetails.Builder	rules(Collection<AwsWafv2RulesDetails> rules)	The Rule statements used to identify the web requests that you want to allow, block, or count.
AwsWafv2RuleGroupDetails.Builder	rules(Consumer<AwsWafv2RulesDetails.Builder>... rules)	The Rule statements used to identify the web requests that you want to allow, block, or count.
AwsWafv2RuleGroupDetails.Builder	rules(AwsWafv2RulesDetails... rules)	The Rule statements used to identify the web requests that you want to allow, block, or count.
AwsWafv2RuleGroupDetails.Builder	scope(String scope)	Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application.
default AwsWafv2RuleGroupDetails.Builder	visibilityConfig(Consumer<AwsWafv2VisibilityConfigDetails.Builder> visibilityConfig)	Defines and enables Amazon CloudWatch metrics and web request sample collection.
AwsWafv2RuleGroupDetails.Builder	visibilityConfig(AwsWafv2VisibilityConfigDetails visibilityConfig)	Defines and enables Amazon CloudWatch metrics and web request sample collection.

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, sdkFieldNameToField, sdkFields

Method Detail

capacity

AwsWafv2RuleGroupDetails.Builder capacity(Long capacity)

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

Parameters:

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

Returns:

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

description

AwsWafv2RuleGroupDetails.Builder description(String description)

A description of the rule group that helps with identification.

Parameters:

description - A description of the rule group that helps with identification.

Returns:

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

id

AwsWafv2RuleGroupDetails.Builder id(String id)

A unique identifier for the rule group.

Parameters:

id - A unique identifier for the rule group.

Returns:

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

name

AwsWafv2RuleGroupDetails.Builder name(String name)

The name of the rule group. You cannot change the name of a rule group after you create it.

Parameters:

name - The name of the rule group. You cannot change the name of a rule group after you create it.

Returns:

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

arn

AwsWafv2RuleGroupDetails.Builder arn(String arn)

The Amazon Resource Name (ARN) of the entity.

Parameters:

arn - The Amazon Resource Name (ARN) of the entity.

Returns:

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

rules

AwsWafv2RuleGroupDetails.Builder rules(Collection<AwsWafv2RulesDetails> rules)

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Parameters:

rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Returns:

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

rules

AwsWafv2RuleGroupDetails.Builder rules(AwsWafv2RulesDetails... rules)

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Parameters:

rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Returns:

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

rules

AwsWafv2RuleGroupDetails.Builder rules(Consumer<AwsWafv2RulesDetails.Builder>... rules)

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

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

Returns:

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

See Also:

#rules(java.util.Collection)

scope

AwsWafv2RuleGroupDetails.Builder scope(String scope)

Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

Parameters:

scope - Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

Returns:

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

visibilityConfig

AwsWafv2RuleGroupDetails.Builder visibilityConfig(AwsWafv2VisibilityConfigDetails visibilityConfig)

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Parameters:

visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.

Returns:

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

visibilityConfig

default AwsWafv2RuleGroupDetails.Builder visibilityConfig(Consumer<AwsWafv2VisibilityConfigDetails.Builder> visibilityConfig)

Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

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

Parameters:

visibilityConfig - a consumer that will call methods on AwsWafv2VisibilityConfigDetails.Builder

Returns:

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

See Also:

visibilityConfig(AwsWafv2VisibilityConfigDetails)