Returns the data objects for the specified rule group¶

Description¶

Returns the data objects for the specified rule group.

Usage¶

networkfirewall_describe_rule_group(RuleGroupName, RuleGroupArn, Type,
  AnalyzeRuleGroup)

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 Amazon Resource Name (ARN) of the rule group.

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.
AnalyzeRuleGroup

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

Value¶

A list with the following syntax:

list(
  UpdateToken = "string",
  RuleGroup = list(
    RuleVariables = list(
      IPSets = list(
        list(
          Definition = list(
            "string"
          )
        )
      ),
      PortSets = list(
        list(
          Definition = list(
            "string"
          )
        )
      )
    ),
    ReferenceSets = list(
      IPSetReferences = list(
        list(
          ReferenceArn = "string"
        )
      )
    ),
    RulesSource = list(
      RulesString = "string",
      RulesSourceList = list(
        Targets = list(
          "string"
        ),
        TargetTypes = list(
          "TLS_SNI"|"HTTP_HOST"
        ),
        GeneratedRulesType = "ALLOWLIST"|"DENYLIST"|"REJECTLIST"|"ALERTLIST"
      ),
      StatefulRules = list(
        list(
          Action = "PASS"|"DROP"|"ALERT"|"REJECT",
          Header = list(
            Protocol = "IP"|"TCP"|"UDP"|"ICMP"|"HTTP"|"FTP"|"TLS"|"SMB"|"DNS"|"DCERPC"|"SSH"|"SMTP"|"IMAP"|"MSN"|"KRB5"|"IKEV2"|"TFTP"|"NTP"|"DHCP"|"HTTP2"|"QUIC",
            Source = "string",
            SourcePort = "string",
            Direction = "FORWARD"|"ANY",
            Destination = "string",
            DestinationPort = "string"
          ),
          RuleOptions = list(
            list(
              Keyword = "string",
              Settings = list(
                "string"
              )
            )
          )
        )
      ),
      StatelessRulesAndCustomActions = list(
        StatelessRules = list(
          list(
            RuleDefinition = list(
              MatchAttributes = list(
                Sources = list(
                  list(
                    AddressDefinition = "string"
                  )
                ),
                Destinations = list(
                  list(
                    AddressDefinition = "string"
                  )
                ),
                SourcePorts = list(
                  list(
                    FromPort = 123,
                    ToPort = 123
                  )
                ),
                DestinationPorts = list(
                  list(
                    FromPort = 123,
                    ToPort = 123
                  )
                ),
                Protocols = list(
                  123
                ),
                TCPFlags = list(
                  list(
                    Flags = list(
                      "FIN"|"SYN"|"RST"|"PSH"|"ACK"|"URG"|"ECE"|"CWR"
                    ),
                    Masks = list(
                      "FIN"|"SYN"|"RST"|"PSH"|"ACK"|"URG"|"ECE"|"CWR"
                    )
                  )
                )
              ),
              Actions = list(
                "string"
              )
            ),
            Priority = 123
          )
        ),
        CustomActions = list(
          list(
            ActionName = "string",
            ActionDefinition = list(
              PublishMetricAction = list(
                Dimensions = list(
                  list(
                    Value = "string"
                  )
                )
              )
            )
          )
        )
      )
    ),
    StatefulRuleOptions = list(
      RuleOrder = "DEFAULT_ACTION_ORDER"|"STRICT_ORDER"
    )
  ),
  RuleGroupResponse = list(
    RuleGroupArn = "string",
    RuleGroupName = "string",
    RuleGroupId = "string",
    Description = "string",
    Type = "STATELESS"|"STATEFUL"|"STATEFUL_DOMAIN",
    Capacity = 123,
    RuleGroupStatus = "ACTIVE"|"DELETING"|"ERROR",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ConsumedCapacity = 123,
    NumberOfAssociations = 123,
    EncryptionConfiguration = list(
      KeyId = "string",
      Type = "CUSTOMER_KMS"|"AWS_OWNED_KMS_KEY"
    ),
    SourceMetadata = list(
      SourceArn = "string",
      SourceUpdateToken = "string"
    ),
    SnsTopic = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    AnalysisResults = list(
      list(
        IdentifiedRuleIds = list(
          "string"
        ),
        IdentifiedType = "STATELESS_RULE_FORWARDING_ASYMMETRICALLY"|"STATELESS_RULE_CONTAINS_TCP_FLAGS",
        AnalysisDetail = "string"
      )
    ),
    SummaryConfiguration = list(
      RuleOptions = list(
        "SID"|"MSG"|"METADATA"
      )
    )
  )
)

Request syntax¶

svc$describe_rule_group(
  RuleGroupName = "string",
  RuleGroupArn = "string",
  Type = "STATELESS"|"STATEFUL"|"STATEFUL_DOMAIN",
  AnalyzeRuleGroup = TRUE|FALSE
)