Amazon Network Firewall · JSON Structure

Openapi Source Metadata Structure

High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Type: object Properties: 2
FirewallIntrusion DetectionNetwork SecurityVPC

SourceMetadata is a JSON Structure definition published by Amazon Network Firewall, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

SourceArn SourceUpdateToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-structure/openapi-source-metadata-structure.json",
  "name": "SourceMetadata",
  "description": "High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling <a href=\"https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html\">DescribeRuleGroup</a>.",
  "type": "object",
  "properties": {
    "SourceArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from."
        }
      ]
    },
    "SourceUpdateToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateToken"
        },
        {
          "description": "The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call <a href=\"https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken\">DescribeRuleGroup</a>."
        }
      ]
    }
  }
}