Describe Rule Group Metadata

networkfirewall_describe_rule_group_metadata

R Documentation

High-level information about a rule group, returned by operations like create and describe

Description

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling describe_rule_group.

Usage

networkfirewall_describe_rule_group_metadata(RuleGroupName,
  RuleGroupArn, Type)

Arguments

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.

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.

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.

Value

A list with the following syntax:

list(
  RuleGroupArn = "string",
  RuleGroupName = "string",
  Description = "string",
  Type = "STATELESS"|"STATEFUL",
  Capacity = 123,
  StatefulRuleOptions = list(
    RuleOrder = "DEFAULT_ACTION_ORDER"|"STRICT_ORDER"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_rule_group_metadata(
  RuleGroupName = "string",
  RuleGroupArn = "string",
  Type = "STATELESS"|"STATEFUL"
)