You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkFirewall::Types::RuleGroupResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity ⇒ Integer

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.

Returns:

  • (Integer) —

    The maximum operating resources that this rule group can use.

#description ⇒ String

A description of the rule group.

Returns:

  • (String) —

    A description of the rule group.

#rule_group_arn ⇒ String

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn\'t attached to a valid resource.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the rule group.

#rule_group_id ⇒ String

The unique identifier for the rule group.

Returns:

  • (String) —

    The unique identifier for the rule group.

#rule_group_name ⇒ String

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

Returns:

  • (String) —

    The descriptive name of the rule group.

#rule_group_status ⇒ String

Detailed information about the current status of a rule group.

Possible values:

  • ACTIVE
  • DELETING

Returns:

  • (String) —

    Detailed information about the current status of a rule group.

#tags ⇒ Array<Types::Tag>

The key:value pairs to associate with the resource.

Returns:

  • (Array<Types::Tag>) —

    The key:value pairs to associate with the resource.

#type ⇒ String

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.

Possible values:

  • STATELESS
  • STATEFUL

Returns:

  • (String) —

    Indicates whether the rule group is stateless or stateful.