com.amazonaws.services.wafv2.model

Class CreateWebACLRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.wafv2.model.CreateWebACLRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWebACLRequest
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
CreateWebACLRequest()

Method Summary

Modifier and Type	Method and Description
CreateWebACLRequest	addCustomResponseBodiesEntry(String key, CustomResponseBody value) Add a single CustomResponseBodies entry
CreateWebACLRequest	clearCustomResponseBodiesEntries() Removes all the entries added into CustomResponseBodies.
CreateWebACLRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AssociationConfig	getAssociationConfig() Specifies custom configurations for the associations between the web ACL and protected resources.
CaptchaConfig	getCaptchaConfig() Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
ChallengeConfig	getChallengeConfig() Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig 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	getName() The name of the web ACL.
List<Rule>	getRules() The Rule statements used to identify the web requests that you want to manage.
String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
List<Tag>	getTags() An array of key:value pairs to associate with the resource.
List<String>	getTokenDomains() Specifies the domains that WAF should accept in a web request token.
VisibilityConfig	getVisibilityConfig() Defines and enables Amazon CloudWatch metrics and web request sample collection.
int	hashCode()
void	setAssociationConfig(AssociationConfig associationConfig) Specifies custom configurations for the associations between the web ACL and protected resources.
void	setCaptchaConfig(CaptchaConfig captchaConfig) Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
void	setChallengeConfig(ChallengeConfig challengeConfig) Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig 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	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 manage.
void	setScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
void	setTags(Collection<Tag> tags) An array of key:value pairs to associate with the resource.
void	setTokenDomains(Collection<String> tokenDomains) Specifies the domains that WAF should accept in a web request token.
void	setVisibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.
String	toString() Returns a string representation of this object.
CreateWebACLRequest	withAssociationConfig(AssociationConfig associationConfig) Specifies custom configurations for the associations between the web ACL and protected resources.
CreateWebACLRequest	withCaptchaConfig(CaptchaConfig captchaConfig) Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
CreateWebACLRequest	withChallengeConfig(ChallengeConfig challengeConfig) Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings.
CreateWebACLRequest	withCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies) A map of custom response keys and content bodies.
CreateWebACLRequest	withDefaultAction(DefaultAction defaultAction) The action to perform if none of the Rules contained in the WebACL match.
CreateWebACLRequest	withDescription(String description) A description of the web ACL that helps with identification.
CreateWebACLRequest	withName(String name) The name of the web ACL.
CreateWebACLRequest	withRules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to manage.
CreateWebACLRequest	withRules(Rule... rules) The Rule statements used to identify the web requests that you want to manage.
CreateWebACLRequest	withScope(Scope scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
CreateWebACLRequest	withScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
CreateWebACLRequest	withTags(Collection<Tag> tags) An array of key:value pairs to associate with the resource.
CreateWebACLRequest	withTags(Tag... tags) An array of key:value pairs to associate with the resource.
CreateWebACLRequest	withTokenDomains(Collection<String> tokenDomains) Specifies the domains that WAF should accept in a web request token.
CreateWebACLRequest	withTokenDomains(String... tokenDomains) Specifies the domains that WAF should accept in a web request token.
CreateWebACLRequest	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

CreateWebACLRequest

public CreateWebACLRequest()

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

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, 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:

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.

See Also:

Scope

withScope

public CreateWebACLRequest 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, 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

withScope

public CreateWebACLRequest 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, 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

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 CreateWebACLRequest 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 CreateWebACLRequest 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 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:

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.

setRules

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

withRules

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

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

withRules

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

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

getTags

public List<Tag> getTags()

An array of key:value pairs to associate with the resource.

Returns:

An array of key:value pairs to associate with the resource.

setTags

public void setTags(Collection<Tag> tags)

An array of key:value pairs to associate with the resource.

Parameters:

tags - An array of key:value pairs to associate with the resource.

withTags

public CreateWebACLRequest withTags(Tag... tags)

An array of key:value pairs to associate with the resource.

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

Parameters:

tags - An array of key:value pairs to associate with the resource.

Returns:

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

withTags

public CreateWebACLRequest withTags(Collection<Tag> tags)

An array of key:value pairs to associate with the resource.

Parameters:

tags - An array of key:value pairs to associate with the resource.

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

setChallengeConfig

public void setChallengeConfig(ChallengeConfig challengeConfig)

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

Parameters:

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

getChallengeConfig

public ChallengeConfig getChallengeConfig()

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

Returns:

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

withChallengeConfig

public CreateWebACLRequest withChallengeConfig(ChallengeConfig challengeConfig)

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

Parameters:

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

Returns:

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

getTokenDomains

public List<String> getTokenDomains()

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Returns:

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

setTokenDomains

public void setTokenDomains(Collection<String> tokenDomains)

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Parameters:

tokenDomains - Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

withTokenDomains

public CreateWebACLRequest withTokenDomains(String... tokenDomains)

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

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

Parameters:

tokenDomains - Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Returns:

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

withTokenDomains

public CreateWebACLRequest withTokenDomains(Collection<String> tokenDomains)

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Parameters:

tokenDomains - Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Returns:

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

setAssociationConfig

public void setAssociationConfig(AssociationConfig associationConfig)

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

Parameters:

associationConfig - Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

getAssociationConfig

public AssociationConfig getAssociationConfig()

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

Returns:

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

withAssociationConfig

public CreateWebACLRequest withAssociationConfig(AssociationConfig associationConfig)

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

Parameters:

associationConfig - Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

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 CreateWebACLRequest 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()