software.amazon.awssdk.services.wafv2.model

Interface UpdateRuleGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>, SdkBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder

Enclosing class:

UpdateRuleGroupRequest

public static interface UpdateRuleGroupRequest.Builder
extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>

Method Summary

Modifier and Type	Method and Description
UpdateRuleGroupRequest.Builder	customResponseBodies(Map<String,CustomResponseBody> customResponseBodies) A map of custom response keys and content bodies.
UpdateRuleGroupRequest.Builder	description(String description) A description of the rule group that helps with identification.
UpdateRuleGroupRequest.Builder	id(String id) A unique identifier for the rule group.
UpdateRuleGroupRequest.Builder	lockToken(String lockToken) A token used for optimistic locking.
UpdateRuleGroupRequest.Builder	name(String name) The name of the rule group.
UpdateRuleGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateRuleGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateRuleGroupRequest.Builder	rules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to manage.
UpdateRuleGroupRequest.Builder	rules(Consumer<Rule.Builder>... rules) The Rule statements used to identify the web requests that you want to manage.
UpdateRuleGroupRequest.Builder	rules(Rule... rules) The Rule statements used to identify the web requests that you want to manage.
UpdateRuleGroupRequest.Builder	scope(Scope scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
UpdateRuleGroupRequest.Builder	scope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
default UpdateRuleGroupRequest.Builder	visibilityConfig(Consumer<VisibilityConfig.Builder> visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.
UpdateRuleGroupRequest.Builder	visibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

name

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

scope

UpdateRuleGroupRequest.Builder scope(String scope)

Specifies whether this 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

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

See Also:

Scope, Scope

scope

UpdateRuleGroupRequest.Builder scope(Scope scope)

Specifies whether this 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

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

See Also:

Scope, Scope

id

UpdateRuleGroupRequest.Builder id(String id)

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Parameters:

id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

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

description

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

rules

UpdateRuleGroupRequest.Builder rules(Collection<Rule> rules)

The Rule statements used to identify the web requests that you want to manage. 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 manage. 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

UpdateRuleGroupRequest.Builder rules(Rule... rules)

The Rule statements used to identify the web requests that you want to manage. 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 manage. 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

UpdateRuleGroupRequest.Builder rules(Consumer<Rule.Builder>... rules)

The Rule statements used to identify the web requests that you want to manage. 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 Rule.Builder avoiding the need to create one manually via Rule.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 Rule.Builder

Returns:

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

See Also:

#rules(java.util.Collection)

visibilityConfig

UpdateRuleGroupRequest.Builder visibilityConfig(VisibilityConfig 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 UpdateRuleGroupRequest.Builder visibilityConfig(Consumer<VisibilityConfig.Builder> visibilityConfig)

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

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

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

Parameters:

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

Returns:

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

See Also:

visibilityConfig(VisibilityConfig)

lockToken

UpdateRuleGroupRequest.Builder lockToken(String lockToken)

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Parameters:

lockToken - A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Returns:

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

customResponseBodies

UpdateRuleGroupRequest.Builder customResponseBodies(Map<String,CustomResponseBody> customResponseBodies)

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

Parameters:

customResponseBodies - A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

Returns:

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

overrideConfiguration

UpdateRuleGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateRuleGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder