Package software.amazon.awscdk.services.wafv2

Class CfnWebACLProps.Builder

java.lang.Object
software.amazon.awscdk.services.wafv2.CfnWebACLProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebACLProps>
Enclosing interface:
CfnWebACLProps
@Stability(Stable) public static final class CfnWebACLProps.Builder extends Object implements software.amazon.jsii.Builder<CfnWebACLProps>
A builder for CfnWebACLProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • defaultAction

      @Stability(Stable) public CfnWebACLProps.Builder defaultAction(IResolvable defaultAction)
      Sets the value of CfnWebACLProps.getDefaultAction()
      Parameters:
      defaultAction - The action to perform if none of the Rules contained in the WebACL match. This parameter is required.
      Returns:
      this

    • defaultAction

      @Stability(Stable) public CfnWebACLProps.Builder defaultAction(CfnWebACL.DefaultActionProperty defaultAction)
      Sets the value of CfnWebACLProps.getDefaultAction()
      Parameters:
      defaultAction - The action to perform if none of the Rules contained in the WebACL match. This parameter is required.
      Returns:
      this

    • scope

      @Stability(Stable) public CfnWebACLProps.Builder scope(String scope)
      Sets the value of CfnWebACLProps.getScope()
      Parameters:
      scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. This parameter is required. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

      For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

      For information about how to define the association of the web ACL with your resource, see WebACLAssociation .

      Returns:
      this

    • visibilityConfig

      @Stability(Stable) public CfnWebACLProps.Builder visibilityConfig(IResolvable visibilityConfig)
      Sets the value of CfnWebACLProps.getVisibilityConfig()
      Parameters:
      visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.
      Returns:
      this

    • visibilityConfig

      @Stability(Stable) public CfnWebACLProps.Builder visibilityConfig(CfnWebACL.VisibilityConfigProperty visibilityConfig)
      Sets the value of CfnWebACLProps.getVisibilityConfig()
      Parameters:
      visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.
      Returns:
      this

    • associationConfig

      @Stability(Stable) public CfnWebACLProps.Builder associationConfig(IResolvable associationConfig)
      Sets the value of CfnWebACLProps.getAssociationConfig()
      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 AWS 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 AWS WAF Pricing .

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

      Returns:
      this

    • associationConfig

      @Stability(Stable) public CfnWebACLProps.Builder associationConfig(CfnWebACL.AssociationConfigProperty associationConfig)
      Sets the value of CfnWebACLProps.getAssociationConfig()
      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 AWS 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 AWS WAF Pricing .

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

      Returns:
      this

    • captchaConfig

      @Stability(Stable) public CfnWebACLProps.Builder captchaConfig(IResolvable captchaConfig)
      Sets the value of CfnWebACLProps.getCaptchaConfig()
      Parameters:
      captchaConfig - Specifies how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, AWS WAF uses its default settings for CaptchaConfig .
      Returns:
      this

    • captchaConfig

      @Stability(Stable) public CfnWebACLProps.Builder captchaConfig(CfnWebACL.CaptchaConfigProperty captchaConfig)
      Sets the value of CfnWebACLProps.getCaptchaConfig()
      Parameters:
      captchaConfig - Specifies how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, AWS WAF uses its default settings for CaptchaConfig .
      Returns:
      this

    • challengeConfig

      @Stability(Stable) public CfnWebACLProps.Builder challengeConfig(IResolvable challengeConfig)
      Sets the value of CfnWebACLProps.getChallengeConfig()
      Parameters:
      challengeConfig - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, AWS WAF uses its default settings for ChallengeConfig .
      Returns:
      this

    • challengeConfig

      @Stability(Stable) public CfnWebACLProps.Builder challengeConfig(CfnWebACL.ChallengeConfigProperty challengeConfig)
      Sets the value of CfnWebACLProps.getChallengeConfig()
      Parameters:
      challengeConfig - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, AWS WAF uses its default settings for ChallengeConfig .
      Returns:
      this

    • customResponseBodies

      @Stability(Stable) public CfnWebACLProps.Builder customResponseBodies(IResolvable customResponseBodies)
      Sets the value of CfnWebACLProps.getCustomResponseBodies()
      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 AWS WAF in the AWS WAF Developer Guide .

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

      Returns:
      this

    • customResponseBodies

      @Stability(Stable) public CfnWebACLProps.Builder customResponseBodies(Map<String,? extends Object> customResponseBodies)
      Sets the value of CfnWebACLProps.getCustomResponseBodies()
      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 AWS WAF in the AWS WAF Developer Guide .

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

      Returns:
      this

    • description

      @Stability(Stable) public CfnWebACLProps.Builder description(String description)
      Sets the value of CfnWebACLProps.getDescription()
      Parameters:
      description - A description of the web ACL that helps with identification.
      Returns:
      this

    • name

      @Stability(Stable) public CfnWebACLProps.Builder name(String name)
      Sets the value of CfnWebACLProps.getName()
      Parameters:
      name - The name of the web ACL. You cannot change the name of a web ACL after you create it.
      Returns:
      this

    • rules

      @Stability(Stable) public CfnWebACLProps.Builder rules(IResolvable rules)
      Sets the value of CfnWebACLProps.getRules()
      Parameters:
      rules - The rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
      Returns:
      this

    • rules

      @Stability(Stable) public CfnWebACLProps.Builder rules(List<? extends Object> rules)
      Sets the value of CfnWebACLProps.getRules()
      Parameters:
      rules - The rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnWebACLProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnWebACLProps.getTags()
      Parameters:
      tags - Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

      To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

      Returns:
      this

    • tokenDomains

      @Stability(Stable) public CfnWebACLProps.Builder tokenDomains(List<String> tokenDomains)
      Sets the value of CfnWebACLProps.getTokenDomains()
      Parameters:
      tokenDomains - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
      Returns:
      this

    • build

      @Stability(Stable) public CfnWebACLProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWebACLProps>
      Returns:
      a new instance of CfnWebACLProps
      Throws:
      NullPointerException - if any required attribute was not provided