/AWS1/CL_WA2MANAGEDRULESETSUMM

High-level information for a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/WA2ENTITYNAME /AWS1/WA2ENTITYNAME

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.

iv_id TYPE /AWS1/WA2ENTITYID /AWS1/WA2ENTITYID

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.

iv_description TYPE /AWS1/WA2ENTITYDESCRIPTION /AWS1/WA2ENTITYDESCRIPTION

A description of the set that helps with identification.

iv_locktoken TYPE /AWS1/WA2LOCKTOKEN /AWS1/WA2LOCKTOKEN

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

iv_arn TYPE /AWS1/WA2RESOURCEARN /AWS1/WA2RESOURCEARN

The Amazon Resource Name (ARN) of the entity.

iv_labelnamespace TYPE /AWS1/WA2LABELNAME /AWS1/WA2LABELNAME

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:::

• 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:

  :

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

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.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

Description

A description of the set that helps with identification.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

LockToken

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Accessible with the following methods

Method	Description
GET_LOCKTOKEN()	Getter for LOCKTOKEN, with configurable default
ASK_LOCKTOKEN()	Getter for LOCKTOKEN w/ exceptions if field has no value
HAS_LOCKTOKEN()	Determine if LOCKTOKEN has a value

ARN

The Amazon Resource Name (ARN) of the entity.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

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:::

• 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:

  :

Accessible with the following methods

Method	Description
GET_LABELNAMESPACE()	Getter for LABELNAMESPACE, with configurable default
ASK_LABELNAMESPACE()	Getter for LABELNAMESPACE w/ exceptions if field has no valu
HAS_LABELNAMESPACE()	Determine if LABELNAMESPACE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_MANAGEDRULESETSUMMARIES

TYPES TT_MANAGEDRULESETSUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_WA2MANAGEDRULESETSUMM WITH DEFAULT KEY
.