/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateWebACLRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String name; /** *

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

* */ private String scope; /** *

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

*/ private DefaultAction defaultAction; /** *

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

*/ private String description; /** *

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

*/ private java.util.List rules; /** *

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

*/ private VisibilityConfig visibilityConfig; /** *

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

*/ private java.util.List tags; /** *

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

*/ private java.util.Map customResponseBodies; /** *

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

*/ private CaptchaConfig captchaConfig; /** *

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

*/ private ChallengeConfig challengeConfig; /** *

* 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 usa.gov or co.uk as token * domains. *

*/ private java.util.List tokenDomains; /** *

* 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 CloudFront distributions forward * to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

* *

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

* */ private AssociationConfig associationConfig; /** *

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

* * @param name * The name of the web ACL. You cannot change the name of a web ACL after you create it. */ public void setName(String name) { this.name = name; } /** *

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

* * @return The name of the web ACL. You cannot change the name of a web ACL after you create it. */ public String getName() { return this.name; } /** *

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

* * @param name * The name of the web ACL. You cannot change the name of a web ACL after you create it. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withName(String name) { setName(name); return this; } /** *

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

    *
    • *
* * @param 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 Scope */ public void setScope(String scope) { this.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. *

      *
      • *
    * * @return 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 Scope */ public String getScope() { return this.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. *

        *
        • *
      * * @param 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. *

        *
        • * @return Returns a reference to this object so that method calls can be chained together. * @see Scope */ public CreateWebACLRequest withScope(String scope) { setScope(scope); return this; } /** *

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

          *
          • *
        * * @param 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. *

          *
          • * @return Returns a reference to this object so that method calls can be chained together. * @see Scope */ public CreateWebACLRequest withScope(Scope scope) { this.scope = scope.toString(); return this; } /** *

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

          * * @param defaultAction * The action to perform if none of the Rules contained in the WebACL match. */ public void setDefaultAction(DefaultAction defaultAction) { this.defaultAction = defaultAction; } /** *

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

          * * @return The action to perform if none of the Rules contained in the WebACL match. */ public DefaultAction getDefaultAction() { return this.defaultAction; } /** *

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

          * * @param defaultAction * The action to perform if none of the Rules contained in the WebACL match. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withDefaultAction(DefaultAction defaultAction) { setDefaultAction(defaultAction); return this; } /** *

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

          * * @param description * A description of the web ACL that helps with identification. */ public void setDescription(String description) { this.description = description; } /** *

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

          * * @return A description of the web ACL that helps with identification. */ public String getDescription() { return this.description; } /** *

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

          * * @param description * A description of the web ACL that helps with identification. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withDescription(String description) { setDescription(description); return this; } /** *

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

          * * @return 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. */ public java.util.List getRules() { return 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. *

          * * @param 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. */ public void setRules(java.util.Collection rules) { if (rules == null) { this.rules = null; return; } this.rules = new java.util.ArrayList(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 * {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the * existing values. *

          * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withRules(Rule... rules) { if (this.rules == null) { setRules(new java.util.ArrayList(rules.length)); } for (Rule ele : rules) { this.rules.add(ele); } return this; } /** *

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

          * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withRules(java.util.Collection rules) { setRules(rules); return this; } /** *

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

          * * @param visibilityConfig * Defines and enables Amazon CloudWatch metrics and web request sample collection. */ public void setVisibilityConfig(VisibilityConfig visibilityConfig) { this.visibilityConfig = visibilityConfig; } /** *

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

          * * @return Defines and enables Amazon CloudWatch metrics and web request sample collection. */ public VisibilityConfig getVisibilityConfig() { return this.visibilityConfig; } /** *

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

          * * @param visibilityConfig * Defines and enables Amazon CloudWatch metrics and web request sample collection. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withVisibilityConfig(VisibilityConfig visibilityConfig) { setVisibilityConfig(visibilityConfig); return this; } /** *

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

          * * @return An array of key:value pairs to associate with the resource. */ public java.util.List getTags() { return tags; } /** *

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

          * * @param tags * An array of key:value pairs to associate with the resource. */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(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 * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *

          * * @param tags * An array of key:value pairs to associate with the resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

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

          * * @param tags * An array of key:value pairs to associate with the resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

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

          * * @return 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. */ public java.util.Map getCustomResponseBodies() { return 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. *

          * * @param 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. */ public void setCustomResponseBodies(java.util.Map customResponseBodies) { this.customResponseBodies = 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. *

          * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withCustomResponseBodies(java.util.Map customResponseBodies) { setCustomResponseBodies(customResponseBodies); return this; } /** * Add a single CustomResponseBodies entry * * @see CreateWebACLRequest#withCustomResponseBodies * @returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest addCustomResponseBodiesEntry(String key, CustomResponseBody value) { if (null == this.customResponseBodies) { this.customResponseBodies = new java.util.HashMap(); } if (this.customResponseBodies.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.customResponseBodies.put(key, value); return this; } /** * Removes all the entries added into CustomResponseBodies. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest clearCustomResponseBodiesEntries() { this.customResponseBodies = null; return this; } /** *

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

          * * @param 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. */ public void setCaptchaConfig(CaptchaConfig captchaConfig) { this.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. *

          * * @return 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. */ public CaptchaConfig getCaptchaConfig() { return this.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. *

          * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withCaptchaConfig(CaptchaConfig captchaConfig) { setCaptchaConfig(captchaConfig); return this; } /** *

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

          * * @param 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. */ public void setChallengeConfig(ChallengeConfig challengeConfig) { this.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. *

          * * @return 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. */ public ChallengeConfig getChallengeConfig() { return this.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. *

          * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withChallengeConfig(ChallengeConfig challengeConfig) { setChallengeConfig(challengeConfig); return this; } /** *

          * 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 usa.gov or co.uk as token * domains. *

          * * @return 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 usa.gov or co.uk as * token domains. */ public java.util.List getTokenDomains() { return 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 usa.gov or co.uk as token * domains. *

          * * @param 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 usa.gov or co.uk as * token domains. */ public void setTokenDomains(java.util.Collection tokenDomains) { if (tokenDomains == null) { this.tokenDomains = null; return; } this.tokenDomains = new java.util.ArrayList(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 usa.gov or co.uk as token * domains. *

          *

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

          * * @param 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 usa.gov or co.uk as * token domains. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withTokenDomains(String... tokenDomains) { if (this.tokenDomains == null) { setTokenDomains(new java.util.ArrayList(tokenDomains.length)); } for (String ele : tokenDomains) { this.tokenDomains.add(ele); } return this; } /** *

          * 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 usa.gov or co.uk as token * domains. *

          * * @param 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 usa.gov or co.uk as * token domains. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withTokenDomains(java.util.Collection tokenDomains) { setTokenDomains(tokenDomains); return this; } /** *

          * 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 CloudFront distributions forward * to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          *           * * @param 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 CloudFront distributions * forward to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          */ public void setAssociationConfig(AssociationConfig associationConfig) { this.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 CloudFront distributions forward * to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          *           * * @return 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 CloudFront distributions * forward to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          */ public AssociationConfig getAssociationConfig() { return this.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 CloudFront distributions forward * to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          *           * * @param 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 CloudFront distributions * forward to WAF for inspection. The default is 16 KB (16,384 kilobytes). *

          * *

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

          * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWebACLRequest withAssociationConfig(AssociationConfig associationConfig) { setAssociationConfig(associationConfig); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getScope() != null) sb.append("Scope: ").append(getScope()).append(","); if (getDefaultAction() != null) sb.append("DefaultAction: ").append(getDefaultAction()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getRules() != null) sb.append("Rules: ").append(getRules()).append(","); if (getVisibilityConfig() != null) sb.append("VisibilityConfig: ").append(getVisibilityConfig()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getCustomResponseBodies() != null) sb.append("CustomResponseBodies: ").append(getCustomResponseBodies()).append(","); if (getCaptchaConfig() != null) sb.append("CaptchaConfig: ").append(getCaptchaConfig()).append(","); if (getChallengeConfig() != null) sb.append("ChallengeConfig: ").append(getChallengeConfig()).append(","); if (getTokenDomains() != null) sb.append("TokenDomains: ").append(getTokenDomains()).append(","); if (getAssociationConfig() != null) sb.append("AssociationConfig: ").append(getAssociationConfig()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateWebACLRequest == false) return false; CreateWebACLRequest other = (CreateWebACLRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getScope() == null ^ this.getScope() == null) return false; if (other.getScope() != null && other.getScope().equals(this.getScope()) == false) return false; if (other.getDefaultAction() == null ^ this.getDefaultAction() == null) return false; if (other.getDefaultAction() != null && other.getDefaultAction().equals(this.getDefaultAction()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getRules() == null ^ this.getRules() == null) return false; if (other.getRules() != null && other.getRules().equals(this.getRules()) == false) return false; if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null) return false; if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getCustomResponseBodies() == null ^ this.getCustomResponseBodies() == null) return false; if (other.getCustomResponseBodies() != null && other.getCustomResponseBodies().equals(this.getCustomResponseBodies()) == false) return false; if (other.getCaptchaConfig() == null ^ this.getCaptchaConfig() == null) return false; if (other.getCaptchaConfig() != null && other.getCaptchaConfig().equals(this.getCaptchaConfig()) == false) return false; if (other.getChallengeConfig() == null ^ this.getChallengeConfig() == null) return false; if (other.getChallengeConfig() != null && other.getChallengeConfig().equals(this.getChallengeConfig()) == false) return false; if (other.getTokenDomains() == null ^ this.getTokenDomains() == null) return false; if (other.getTokenDomains() != null && other.getTokenDomains().equals(this.getTokenDomains()) == false) return false; if (other.getAssociationConfig() == null ^ this.getAssociationConfig() == null) return false; if (other.getAssociationConfig() != null && other.getAssociationConfig().equals(this.getAssociationConfig()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode()); hashCode = prime * hashCode + ((getDefaultAction() == null) ? 0 : getDefaultAction().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode()); hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getCustomResponseBodies() == null) ? 0 : getCustomResponseBodies().hashCode()); hashCode = prime * hashCode + ((getCaptchaConfig() == null) ? 0 : getCaptchaConfig().hashCode()); hashCode = prime * hashCode + ((getChallengeConfig() == null) ? 0 : getChallengeConfig().hashCode()); hashCode = prime * hashCode + ((getTokenDomains() == null) ? 0 : getTokenDomains().hashCode()); hashCode = prime * hashCode + ((getAssociationConfig() == null) ? 0 : getAssociationConfig().hashCode()); return hashCode; } @Override public CreateWebACLRequest clone() { return (CreateWebACLRequest) super.clone(); } }