ManagedRuleSet - AWS WAFV2

ManagedRuleSet

A set of rules that is managed by AWS and AWS Marketplace sellers to provide versioned managed rule groups for customers of AWS WAF.

Note

This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Contents

ARN

The Amazon Resource Name (ARN) of the entity.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*\S.*

Required: Yes

Description

A description of the set that helps with identification.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

Required: Yes

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, AWS 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>

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[0-9A-Za-z_\-:]+$

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\w\-]+$

Required: Yes

PublishedVersions

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

Type: String to ManagedRuleSetVersion object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[\w#:\.\-/]+$

Required: No

RecommendedVersion

The version that you would like your customers to use.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w#:\.\-/]+$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: