com.amazonaws.services.wafv2.model

Class UpdateWebACLRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.wafv2.model.UpdateWebACLRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateWebACLRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateWebACLRequest()

Method Summary

Modifier and Type	Method and Description
UpdateWebACLRequest	addCustomResponseBodiesEntry(String key, CustomResponseBody value) Add a single CustomResponseBodies entry
UpdateWebACLRequest	clearCustomResponseBodiesEntries() Removes all the entries added into CustomResponseBodies.
UpdateWebACLRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CaptchaConfig	getCaptchaConfig() Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
Map<String,CustomResponseBody>	getCustomResponseBodies() A map of custom response keys and content bodies.
DefaultAction	getDefaultAction() The action to perform if none of the Rules contained in the WebACL match.
String	getDescription() A description of the web ACL that helps with identification.
String	getId() The unique identifier for the web ACL.
String	getLockToken() A token used for optimistic locking.
String	getName() The name of the web ACL.
List<Rule>	getRules() The Rule statements used to identify the web requests that you want to allow, block, or count.
String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
VisibilityConfig	getVisibilityConfig() Defines and enables Amazon CloudWatch metrics and web request sample collection.
int	hashCode()
void	setCaptchaConfig(CaptchaConfig captchaConfig) Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
void	setCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies) A map of custom response keys and content bodies.
void	setDefaultAction(DefaultAction defaultAction) The action to perform if none of the Rules contained in the WebACL match.
void	setDescription(String description) A description of the web ACL that helps with identification.
void	setId(String id) The unique identifier for the web ACL.
void	setLockToken(String lockToken) A token used for optimistic locking.
void	setName(String name) The name of the web ACL.
void	setRules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
void	setScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
void	setVisibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.
String	toString() Returns a string representation of this object.
UpdateWebACLRequest	withCaptchaConfig(CaptchaConfig captchaConfig) Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
UpdateWebACLRequest	withCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies) A map of custom response keys and content bodies.
UpdateWebACLRequest	withDefaultAction(DefaultAction defaultAction) The action to perform if none of the Rules contained in the WebACL match.
UpdateWebACLRequest	withDescription(String description) A description of the web ACL that helps with identification.
UpdateWebACLRequest	withId(String id) The unique identifier for the web ACL.
UpdateWebACLRequest	withLockToken(String lockToken) A token used for optimistic locking.
UpdateWebACLRequest	withName(String name) The name of the web ACL.
UpdateWebACLRequest	withRules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
UpdateWebACLRequest	withRules(Rule... rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
UpdateWebACLRequest	withScope(Scope scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
UpdateWebACLRequest	withScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
UpdateWebACLRequest	withVisibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateWebACLRequest

public UpdateWebACLRequest()

Method Detail

setName

public void setName(String name)

The name of the web ACL. You cannot change the name of a web ACL after you create it.

Parameters:

name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

getName

public String getName()

The name of the web ACL. You cannot change the name of a web ACL after you create it.

Returns:

The name of the web ACL. You cannot change the name of a web ACL after you create it.

withName

public UpdateWebACLRequest withName(String name)

The name of the web ACL. You cannot change the name of a web ACL after you create it.

Parameters:

name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

Returns:

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

setScope

public void setScope(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, or an AppSync GraphQL API.

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, or an AppSync GraphQL API.

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.

See Also:

Scope

getScope

public String getScope()

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, or an AppSync GraphQL API.

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:

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, or an AppSync GraphQL API.

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.

See Also:

Scope

withScope

public UpdateWebACLRequest withScope(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, or an AppSync GraphQL API.

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, or an AppSync GraphQL API.

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

withScope

public UpdateWebACLRequest withScope(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, or an AppSync GraphQL API.

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, or an AppSync GraphQL API.

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

setId

public void setId(String id)

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Parameters:

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

getId

public String getId()

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

withId

public UpdateWebACLRequest withId(String id)

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Parameters:

id - The unique identifier for the web ACL. 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.

setDefaultAction

public void setDefaultAction(DefaultAction defaultAction)

The action to perform if none of the Rules contained in the WebACL match.

Parameters:

defaultAction - The action to perform if none of the Rules contained in the WebACL match.

getDefaultAction

public DefaultAction getDefaultAction()

The action to perform if none of the Rules contained in the WebACL match.

Returns:

The action to perform if none of the Rules contained in the WebACL match.

withDefaultAction

public UpdateWebACLRequest withDefaultAction(DefaultAction defaultAction)

The action to perform if none of the Rules contained in the WebACL match.

Parameters:

defaultAction - The action to perform if none of the Rules contained in the WebACL match.

Returns:

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

setDescription

public void setDescription(String description)

A description of the web ACL that helps with identification.

Parameters:

description - A description of the web ACL that helps with identification.

getDescription

public String getDescription()

A description of the web ACL that helps with identification.

Returns:

A description of the web ACL that helps with identification.

withDescription

public UpdateWebACLRequest withDescription(String description)

A description of the web ACL that helps with identification.

Parameters:

description - A description of the web ACL that helps with identification.

Returns:

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

getRules

public List<Rule> getRules()

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:

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.

setRules

public void setRules(Collection<Rule> 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.

withRules

public UpdateWebACLRequest withRules(Rule... 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.

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

withRules

public UpdateWebACLRequest withRules(Collection<Rule> 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.

setVisibilityConfig

public void setVisibilityConfig(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.

getVisibilityConfig

public VisibilityConfig getVisibilityConfig()

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

Returns:

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

withVisibilityConfig

public UpdateWebACLRequest withVisibilityConfig(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.

setLockToken

public void setLockToken(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.

getLockToken

public String getLockToken()

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:

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.

withLockToken

public UpdateWebACLRequest withLockToken(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.

getCustomResponseBodies

public Map<String,CustomResponseBody> getCustomResponseBodies()

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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:

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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.

setCustomResponseBodies

public void setCustomResponseBodies(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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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.

withCustomResponseBodies

public UpdateWebACLRequest withCustomResponseBodies(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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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.

addCustomResponseBodiesEntry

public UpdateWebACLRequest addCustomResponseBodiesEntry(String key,
                                                        CustomResponseBody value)

Add a single CustomResponseBodies entry

See Also:

withCustomResponseBodies(java.util.Map<java.lang.String, com.amazonaws.services.wafv2.model.CustomResponseBody>)

clearCustomResponseBodiesEntries

public UpdateWebACLRequest clearCustomResponseBodiesEntries()

Removes all the entries added into CustomResponseBodies.

Returns:

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

setCaptchaConfig

public void setCaptchaConfig(CaptchaConfig captchaConfig)

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

Parameters:

captchaConfig - Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

getCaptchaConfig

public CaptchaConfig getCaptchaConfig()

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

Returns:

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

withCaptchaConfig

public UpdateWebACLRequest withCaptchaConfig(CaptchaConfig captchaConfig)

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

Parameters:

captchaConfig - Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateWebACLRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()