Documentation

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.

See: newRuleGroupResponse smart constructor.

Create a value of RuleGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacity:RuleGroupResponse', ruleGroupResponse_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.

$sel:consumedCapacity:RuleGroupResponse', ruleGroupResponse_consumedCapacity - The number of capacity units currently consumed by the rule group rules.

$sel:description:RuleGroupResponse', ruleGroupResponse_description - A description of the rule group.

$sel:encryptionConfiguration:RuleGroupResponse', ruleGroupResponse_encryptionConfiguration - A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

$sel:lastModifiedTime:RuleGroupResponse', ruleGroupResponse_lastModifiedTime - The last time that the rule group was changed.

$sel:numberOfAssociations:RuleGroupResponse', ruleGroupResponse_numberOfAssociations - The number of firewall policies that use this rule group.

$sel:ruleGroupStatus:RuleGroupResponse', ruleGroupResponse_ruleGroupStatus - Detailed information about the current status of a rule group.

$sel:snsTopic:RuleGroupResponse', ruleGroupResponse_snsTopic - The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..

$sel:sourceMetadata:RuleGroupResponse', ruleGroupResponse_sourceMetadata - A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

$sel:tags:RuleGroupResponse', ruleGroupResponse_tags - The key:value pairs to associate with the resource.

RuleGroupResponse, ruleGroupResponse_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.

$sel:ruleGroupArn:RuleGroupResponse', ruleGroupResponse_ruleGroupArn - 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.

$sel:ruleGroupName:RuleGroupResponse', ruleGroupResponse_ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.

$sel:ruleGroupId:RuleGroupResponse', ruleGroupResponse_ruleGroupId - The unique identifier for the rule group.

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.

The number of capacity units currently consumed by the rule group rules.

A description of the rule group.

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

The last time that the rule group was changed.

The number of firewall policies that use this rule group.

Detailed information about the current status of a rule group.

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

The key:value pairs to associate with the resource.

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.

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.

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

The unique identifier for the rule group.