Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroupProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • capacity

      @Stability(Stable) public CfnRuleGroupProps.Builder capacity(Number capacity)
      Sets the value of CfnRuleGroupProps.getCapacity()
      Parameters:
      capacity - The web ACL capacity units (WCUs) required for this rule group. This parameter is required. When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit.

      AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

      Returns:
      this

    • scope

      @Stability(Stable) public CfnRuleGroupProps.Builder scope(String scope)
      Sets the value of CfnRuleGroupProps.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 .

      Returns:
      this

    • visibilityConfig

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

    • visibilityConfig

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

    • availableLabels

      @Stability(Stable) public CfnRuleGroupProps.Builder availableLabels(IResolvable availableLabels)
      Sets the value of CfnRuleGroupProps.getAvailableLabels()
      Parameters:
      availableLabels - The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule .
      Returns:
      this

    • availableLabels

      @Stability(Stable) public CfnRuleGroupProps.Builder availableLabels(List<? extends Object> availableLabels)
      Sets the value of CfnRuleGroupProps.getAvailableLabels()
      Parameters:
      availableLabels - The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule .
      Returns:
      this

    • consumedLabels

      @Stability(Stable) public CfnRuleGroupProps.Builder consumedLabels(IResolvable consumedLabels)
      Sets the value of CfnRuleGroupProps.getConsumedLabels()
      Parameters:
      consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
      Returns:
      this

    • consumedLabels

      @Stability(Stable) public CfnRuleGroupProps.Builder consumedLabels(List<? extends Object> consumedLabels)
      Sets the value of CfnRuleGroupProps.getConsumedLabels()
      Parameters:
      consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
      Returns:
      this

    • customResponseBodies

      @Stability(Stable) public CfnRuleGroupProps.Builder customResponseBodies(IResolvable customResponseBodies)
      Sets the value of CfnRuleGroupProps.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 rule group, and then use them in the rules that you define in the rule group.

      For information about customizing web requests and responses, see Customizing web requests and responses in 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 CfnRuleGroupProps.Builder customResponseBodies(Map<String,? extends Object> customResponseBodies)
      Sets the value of CfnRuleGroupProps.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 rule group, and then use them in the rules that you define in the rule group.

      For information about customizing web requests and responses, see Customizing web requests and responses in 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 CfnRuleGroupProps.Builder description(String description)
      Sets the value of CfnRuleGroupProps.getDescription()
      Parameters:
      description - A description of the rule group that helps with identification.
      Returns:
      this

    • name

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

    • rules

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

    • rules

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

    • tags

      @Stability(Stable) public CfnRuleGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnRuleGroupProps.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

    • build

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