/AWS1/CL_NWFDESCRRULEGRPMETRSP

DescribeRuleGroupMetadataResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_rulegrouparn TYPE /AWS1/NWFRESOURCEARN /AWS1/NWFRESOURCEARN

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

iv_rulegroupname TYPE /AWS1/NWFRESOURCENAME /AWS1/NWFRESOURCENAME

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

Optional arguments:

iv_description TYPE /AWS1/NWFDESCRIPTION /AWS1/NWFDESCRIPTION

Returns the metadata objects for the specified rule group.

iv_type TYPE /AWS1/NWFRULEGROUPTYPE /AWS1/NWFRULEGROUPTYPE

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

iv_capacity TYPE /AWS1/NWFRULECAPACITY /AWS1/NWFRULECAPACITY

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

io_statefulruleoptions TYPE REF TO /AWS1/CL_NWFSTATEFULRULEOPTS /AWS1/CL_NWFSTATEFULRULEOPTS

StatefulRuleOptions

iv_lastmodifiedtime TYPE /AWS1/NWFLASTUPDATETIME /AWS1/NWFLASTUPDATETIME

A timestamp indicating when the rule group was last modified.

iv_vendorname TYPE /AWS1/NWFVENDORNAME /AWS1/NWFVENDORNAME

The name of the Amazon Web Services Marketplace vendor that provides this rule group.

iv_productid TYPE /AWS1/NWFPRODUCTID /AWS1/NWFPRODUCTID

The unique identifier for the product listing associated with this rule group.

iv_listingname TYPE /AWS1/NWFLISTINGNAME /AWS1/NWFLISTINGNAME

The display name of the product listing for this rule group.

---

Queryable Attributes

RuleGroupArn

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

Accessible with the following methods

Method	Description
GET_RULEGROUPARN()	Getter for RULEGROUPARN, with configurable default
ASK_RULEGROUPARN()	Getter for RULEGROUPARN w/ exceptions if field has no value
HAS_RULEGROUPARN()	Determine if RULEGROUPARN has a value

RuleGroupName

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

Accessible with the following methods

Method	Description
GET_RULEGROUPNAME()	Getter for RULEGROUPNAME, with configurable default
ASK_RULEGROUPNAME()	Getter for RULEGROUPNAME w/ exceptions if field has no value
HAS_RULEGROUPNAME()	Determine if RULEGROUPNAME has a value

Description

Returns the metadata objects for the specified rule group.

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

Type

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

Capacity

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Accessible with the following methods

Method	Description
GET_CAPACITY()	Getter for CAPACITY, with configurable default
ASK_CAPACITY()	Getter for CAPACITY w/ exceptions if field has no value
HAS_CAPACITY()	Determine if CAPACITY has a value

StatefulRuleOptions

StatefulRuleOptions

Accessible with the following methods

Method	Description
GET_STATEFULRULEOPTIONS()	Getter for STATEFULRULEOPTIONS

LastModifiedTime

A timestamp indicating when the rule group was last modified.

Accessible with the following methods

Method	Description
GET_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME, with configurable default
ASK_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME w/ exceptions if field has no va
HAS_LASTMODIFIEDTIME()	Determine if LASTMODIFIEDTIME has a value

VendorName

The name of the Amazon Web Services Marketplace vendor that provides this rule group.

Accessible with the following methods

Method	Description
GET_VENDORNAME()	Getter for VENDORNAME, with configurable default
ASK_VENDORNAME()	Getter for VENDORNAME w/ exceptions if field has no value
HAS_VENDORNAME()	Determine if VENDORNAME has a value

ProductId

The unique identifier for the product listing associated with this rule group.

Accessible with the following methods

Method	Description
GET_PRODUCTID()	Getter for PRODUCTID, with configurable default
ASK_PRODUCTID()	Getter for PRODUCTID w/ exceptions if field has no value
HAS_PRODUCTID()	Determine if PRODUCTID has a value

ListingName

The display name of the product listing for this rule group.

Accessible with the following methods

Method	Description
GET_LISTINGNAME()	Getter for LISTINGNAME, with configurable default
ASK_LISTINGNAME()	Getter for LISTINGNAME w/ exceptions if field has no value
HAS_LISTINGNAME()	Determine if LISTINGNAME has a value