Package software.amazon.awssdk.services.wafv2.model

Interface RuleGroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RuleGroup.Builder,RuleGroup>, SdkBuilder<RuleGroup.Builder,RuleGroup>, SdkPojo
Enclosing class:
RuleGroup
public static interface RuleGroup.Builder extends SdkPojo, CopyableBuilder<RuleGroup.Builder,RuleGroup>

  • Method Details

    • name

      RuleGroup.Builder name(String name)

      The name of the rule group. You cannot change the name of a rule group after you create it.

      Parameters:
      name - The name of the rule group. You cannot change the name of a rule group after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      RuleGroup.Builder id(String id)

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      Parameters:
      id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacity

      RuleGroup.Builder capacity(Long capacity)

      The web ACL capacity units (WCUs) required for this rule group.

      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, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

      Parameters:
      capacity - The web ACL capacity units (WCUs) required for this rule group.

      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, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

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

    • arn

      RuleGroup.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the entity.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      RuleGroup.Builder description(String description)

      A description of the rule group that helps with identification.

      Parameters:
      description - A description of the rule group that helps with identification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rules

      RuleGroup.Builder rules(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.

    • rules

      RuleGroup.Builder rules(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.

    • rules

      RuleGroup.Builder rules(Consumer<Rule.Builder>... 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.

      This is a convenience method that creates an instance of the Rule.Builder avoiding the need to create one manually via Rule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rules(List<Rule>).

      Parameters:
      rules - a consumer that will call methods on Rule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibilityConfig

      RuleGroup.Builder visibilityConfig(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.

    • visibilityConfig

      default RuleGroup.Builder visibilityConfig(Consumer<VisibilityConfig.Builder> visibilityConfig)

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

      This is a convenience method that creates an instance of the VisibilityConfig.Builder avoiding the need to create one manually via VisibilityConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visibilityConfig(VisibilityConfig).

      Parameters:
      visibilityConfig - a consumer that will call methods on VisibilityConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • labelNamespace

      RuleGroup.Builder labelNamespace(String labelNamespace)

      The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

      • The syntax for the label namespace prefix for your rule groups is the following:

        awswaf:<account ID>:rulegroup:<rule group name>:

      • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

        <label namespace>:<label from rule>

      Parameters:
      labelNamespace - The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

      • The syntax for the label namespace prefix for your rule groups is the following:

        awswaf:<account ID>:rulegroup:<rule group name>:

      • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

        <label namespace>:<label from rule>

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

    • customResponseBodies

      RuleGroup.Builder customResponseBodies(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 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 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 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 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.

    • availableLabels

      RuleGroup.Builder availableLabels(Collection<LabelSummary> 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • availableLabels

      RuleGroup.Builder availableLabels(LabelSummary... 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • availableLabels

      RuleGroup.Builder availableLabels(Consumer<LabelSummary.Builder>... 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.

      This is a convenience method that creates an instance of the LabelSummary.Builder avoiding the need to create one manually via LabelSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availableLabels(List<LabelSummary>).

      Parameters:
      availableLabels - a consumer that will call methods on LabelSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • consumedLabels

      RuleGroup.Builder consumedLabels(Collection<LabelSummary> 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • consumedLabels

      RuleGroup.Builder consumedLabels(LabelSummary... 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • consumedLabels

      RuleGroup.Builder consumedLabels(Consumer<LabelSummary.Builder>... 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.

      This is a convenience method that creates an instance of the LabelSummary.Builder avoiding the need to create one manually via LabelSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to consumedLabels(List<LabelSummary>).

      Parameters:
      consumedLabels - a consumer that will call methods on LabelSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: