Interface ManagedRuleSet.Builder

  • Method Details

    • name

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

      Parameters:
      name - The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

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

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

      Parameters:
      id - A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      ManagedRuleSet.Builder description(String description)

      A description of the set that helps with identification.

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

      ManagedRuleSet.Builder publishedVersions(Map<String,ManagedRuleSetVersion> publishedVersions)

      The versions of this managed rule set that are available for use by customers.

      Parameters:
      publishedVersions - The versions of this managed rule set that are available for use by customers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendedVersion

      ManagedRuleSet.Builder recommendedVersion(String recommendedVersion)

      The version that you would like your customers to use.

      Parameters:
      recommendedVersion - The version that you would like your customers to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • labelNamespace

      ManagedRuleSet.Builder labelNamespace(String labelNamespace)

      The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following:

        awswaf:managed:<vendor>:<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 the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following:

        awswaf:managed:<vendor>:<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.