DescribeRuleGroupMetadataRequest

DescribeRuleGroupMetadataRequest schema from Amazon Network Firewall

FirewallIntrusion DetectionNetwork SecurityVPC

Properties

Name Type Description
RuleGroupName object
RuleGroupArn object
Type object
View JSON Schema on GitHub

JSON Schema

openapi-describe-rule-group-metadata-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-schema/openapi-describe-rule-group-metadata-request-schema.json",
  "title": "DescribeRuleGroupMetadataRequest",
  "description": "DescribeRuleGroupMetadataRequest schema from Amazon Network Firewall",
  "type": "object",
  "properties": {
    "RuleGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
        }
      ]
    },
    "RuleGroupArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceArn"
        },
        {
          "description": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleGroupType"
        },
        {
          "description": "<p>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. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>"
        }
      ]
    }
  }
}