The #X Amz Target=NetworkFirewall 20201112.DescribeRuleGroup API from Amazon Network Firewall — 1 operation(s) for #x amz target=networkfirewall 20201112.describerulegroup.
openapi: 3.0.0
info:
version: 2020-11-12
x-release: v4
title: 'AWS Network Firewall #X Amz Target=NetworkFirewall 20201112.AssociateFirewallPolicy #X Amz Target=NetworkFirewall 20201112.AssociateFirewallPolicy #X Amz Target=NetworkFirewall 20201112.DescribeRuleGroup API'
description: '<p>This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <ul> <li> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a>. </p> <p>To access Network Firewall using the REST API endpoint: <code>https://network-firewall.<region>.amazonaws.com </code> </p> </li> <li> <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that''s tailored to the programming language or platform that you''re using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> </li> <li> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/">Network Firewall Developer Guide</a>.</p> </li> </ul> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 6.0.9. For information about Suricata, see the <a href="https://suricata.io/">Suricata website</a>.</p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don''t already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that''s defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: network-firewall
x-aws-signingName: network-firewall
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/network-firewall-2020-11-12.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://network-firewall.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Network Firewall multi-region endpoint
- url: https://network-firewall.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Network Firewall multi-region endpoint
- url: http://network-firewall.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
- url: https://network-firewall.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=NetworkFirewall 20201112.DescribeRuleGroup'
paths:
/#X-Amz-Target=NetworkFirewall_20201112.DescribeRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeRuleGroup
description: 'Returns the data objects for the specified rule group. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRuleGroupResponse'
examples:
DescribeRuleGroup200Example:
summary: Default DescribeRuleGroup 200 response
x-microcks-default: true
value:
UpdateToken: example-string
RuleGroup: example-string
RuleGroupResponse: example-string
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- NetworkFirewall_20201112.DescribeRuleGroup
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Network Firewall Describe Rule Group
tags:
- '#X Amz Target=NetworkFirewall 20201112.DescribeRuleGroup'
components:
schemas:
ResourceNotFoundException: {}
Keyword:
type: string
pattern: .*
minLength: 1
maxLength: 128
ThrottlingException: {}
ProtocolNumbers:
type: array
items:
$ref: '#/components/schemas/ProtocolNumber'
Dimensions:
type: array
items:
$ref: '#/components/schemas/Dimension'
minItems: 1
maxItems: 1
ResourceStatus:
type: string
enum:
- ACTIVE
- DELETING
Source:
type: string
pattern: ^.*$
minLength: 1
maxLength: 1024
RulesSource:
type: object
properties:
RulesString:
allOf:
- $ref: '#/components/schemas/RulesString'
- description: <p>Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.</p> <p>These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.</p>
RulesSourceList:
allOf:
- $ref: '#/components/schemas/RulesSourceList'
- description: 'Stateful inspection criteria for a domain list rule group. '
StatefulRules:
allOf:
- $ref: '#/components/schemas/StatefulRules'
- description: 'An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href="https://suricata.readthedocs.iorules/intro.html#">Rules Format</a>. '
StatelessRulesAndCustomActions:
allOf:
- $ref: '#/components/schemas/StatelessRulesAndCustomActions'
- description: 'Stateless inspection criteria to be used in a stateless rule group. '
description: 'The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single <code>RulesSource</code>. You can use an instance of this for either stateless rules or stateful rules. '
ResourceId:
type: string
pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
minLength: 36
maxLength: 36
TargetType:
type: string
enum:
- TLS_SNI
- HTTP_HOST
RuleTargets:
type: array
items:
$ref: '#/components/schemas/CollectionMember_String'
ActionName:
type: string
pattern: ^[a-zA-Z0-9]+$
minLength: 1
maxLength: 128
VariableDefinitionList:
type: array
items:
$ref: '#/components/schemas/VariableDefinition'
Destination:
type: string
pattern: ^.*$
minLength: 1
maxLength: 1024
ReferenceSets:
type: object
properties:
IPSetReferences:
allOf:
- $ref: '#/components/schemas/IPSetReferenceMap'
- description: The list of IP set references.
description: Contains a set of IP set references.
RuleOrder:
type: string
enum:
- DEFAULT_ACTION_ORDER
- STRICT_ORDER
DescribeRuleGroupRequest:
type: object
title: DescribeRuleGroupRequest
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 Amazon Resource Name (ARN) of the rule group.</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>
Setting:
type: string
pattern: .*
minLength: 1
maxLength: 8192
ResourceArn:
type: string
pattern: ^arn:aws.*
minLength: 1
maxLength: 256
TargetTypes:
type: array
items:
$ref: '#/components/schemas/TargetType'
RuleVariables:
type: object
properties:
IPSets:
allOf:
- $ref: '#/components/schemas/IPSets'
- description: 'A list of IP addresses and address ranges, in CIDR notation. '
PortSets:
allOf:
- $ref: '#/components/schemas/PortSets'
- description: 'A list of port ranges. '
description: 'Settings that are available for use in the rules in the <a>RuleGroup</a> where this is defined. '
StatefulRuleProtocol:
type: string
enum:
- IP
- TCP
- UDP
- ICMP
- HTTP
- FTP
- TLS
- SMB
- DNS
- DCERPC
- SSH
- SMTP
- IMAP
- MSN
- KRB5
- IKEV2
- TFTP
- NTP
- DHCP
AddressDefinition:
type: string
pattern: ^([a-fA-F\d:\.]+($|/\d{1,3}))$
minLength: 1
maxLength: 255
GeneratedRulesType:
type: string
enum:
- ALLOWLIST
- DENYLIST
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 200
CustomActions:
type: array
items:
$ref: '#/components/schemas/CustomAction'
PortSet:
type: object
properties:
Definition:
allOf:
- $ref: '#/components/schemas/VariableDefinitionList'
- description: 'The set of port ranges. '
description: 'A set of port ranges for use in the rules in a rule group. '
RuleCapacity:
type: integer
Priority:
type: integer
minimum: 1
maximum: 65535
CustomAction:
type: object
required:
- ActionName
- ActionDefinition
properties:
ActionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition:
allOf:
- $ref: '#/components/schemas/ActionDefinition'
- description: The custom action associated with the action name.
description: '<p>An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify. </p> <p>You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings. </p> <p>You can use custom actions in the following places: </p> <ul> <li> <p>In a rule group''s <a>StatelessRulesAndCustomActions</a> specification. The custom actions are available for use by name inside the <code>StatelessRulesAndCustomActions</code> where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule''s match attributes. </p> </li> <li> <p>In a <a>FirewallPolicy</a> specification, in <code>StatelessCustomActions</code>. The custom actions are available for use inside the policy where you define them. You can use them for the policy''s default stateless actions settings to specify what to do with packets that don''t match any of the policy''s stateless rules. </p> </li> </ul>'
StatelessRule:
type: object
required:
- RuleDefinition
- Priority
properties:
RuleDefinition:
allOf:
- $ref: '#/components/schemas/RuleDefinition'
- description: 'Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: <p>Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group. </p> <p>Each stateless rule group uses exactly one <code>StatelessRulesAndCustomActions</code> object, and each <code>StatelessRulesAndCustomActions</code> contains exactly one <code>StatelessRules</code> object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single <code>StatelessRules</code> object.</p> <p>You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on. </p>
description: A single stateless rule. This is used in <a>StatelessRulesAndCustomActions</a>.
IPSetReference:
type: object
properties:
ReferenceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
description: <p>Configures one or more IP set references for a Suricata-compatible rule group. This is used in <a>CreateRuleGroup</a> or <a>UpdateRuleGroup</a>. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references">Using IP set references</a> in the <i>Network Firewall Developer Guide</i>.</p> <p> Network Firewall currently supports <a href="https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html">Amazon VPC prefix lists</a> and <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html#rule-groups-referencing-resource-groups">resource groups</a> in IP set references. </p>
Description:
type: string
pattern: ^.*$
maxLength: 512
StatelessRules:
type: array
items:
$ref: '#/components/schemas/StatelessRule'
StatelessRulesAndCustomActions:
type: object
required:
- StatelessRules
properties:
StatelessRules:
allOf:
- $ref: '#/components/schemas/StatelessRules'
- description: 'Defines the set of stateless rules for use in a stateless rule group. '
CustomActions:
allOf:
- $ref: '#/components/schemas/CustomActions'
- description: Defines an array of individual custom action definitions that are available for use by the stateless rules in this <code>StatelessRulesAndCustomActions</code> specification. You name each custom action that you define, and then you can use it by name in your <a>StatelessRule</a> <a>RuleDefinition</a> <code>Actions</code> specification.
description: 'Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules. '
Addresses:
type: array
items:
$ref: '#/components/schemas/Address'
KeyId:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 2048
EncryptionType:
type: string
enum:
- CUSTOMER_KMS
- AWS_OWNED_KMS_KEY
DimensionValue:
type: string
pattern: ^[a-zA-Z0-9-_ ]+$
minLength: 1
maxLength: 128
Flags:
type: array
items:
$ref: '#/components/schemas/TCPFlag'
RuleDefinition:
type: object
required:
- MatchAttributes
- Actions
properties:
MatchAttributes:
allOf:
- $ref: '#/components/schemas/MatchAttributes'
- description: 'Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags. '
Actions:
allOf:
- $ref: '#/components/schemas/StatelessActions'
- description: <p>The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions. </p> <note> <p>Network Firewall only forwards a packet for stateful rule inspection if you specify <code>aws:forward_to_sfe</code> for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify <code>aws:forward_to_sfe</code> for the <code>StatelessDefaultActions</code> setting for the <a>FirewallPolicy</a>.</p> </note> <p>For every rule, you must specify exactly one of the following standard actions. </p> <ul> <li> <p> <b>aws:pass</b> - Discontinues all inspection of the packet and permits it to go to its intended destination.</p> </li> <li> <p> <b>aws:drop</b> - Discontinues all inspection of the packet and blocks it from going to its intended destination.</p> </li> <li> <p> <b>aws:forward_to_sfe</b> - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection. </p> </li> </ul> <p>Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this <code>Actions</code> setting. For information about the options, see <a>CustomAction</a>. </p> <p>To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom <code>PublishMetrics</code> action that you've named <code>MyMetricsAction</code>, then you could specify the standard action <code>aws:pass</code> and the custom action with <code>[“aws:pass”, “MyMetricsAction”]</code>. </p>
description: The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
StatefulRuleDirection:
type: string
enum:
- FORWARD
- ANY
NumberOfAssociations:
type: integer
StatefulRuleOptions:
type: object
properties:
RuleOrder:
allOf:
- $ref: '#/components/schemas/RuleOrder'
- description: 'Indicates how to manage the order of the rule evaluation for the rule group. <code>DEFAULT_ACTION_ORDER</code> is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html">Evaluation order for stateful rules</a> in the <i>Network Firewall Developer Guide</i>. '
description: Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
MatchAttributes:
type: object
properties:
Sources:
allOf:
- $ref: '#/components/schemas/Addresses'
- description: 'The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address. '
Destinations:
allOf:
- $ref: '#/components/schemas/Addresses'
- description: 'The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address. '
SourcePorts:
allOf:
- $ref: '#/components/schemas/PortRanges'
- description: <p>The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP). </p> <p>You can specify individual ports, for example <code>1994</code> and you can specify port ranges, for example <code>1990:1994</code>. </p>
DestinationPorts:
allOf:
- $ref: '#/components/schemas/PortRanges'
- description: <p>The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP). </p> <p>You can specify individual ports, for example <code>1994</code> and you can specify port ranges, for example <code>1990:1994</code>. </p>
Protocols:
allOf:
- $ref: '#/components/schemas/ProtocolNumbers'
- description: 'The protocols to inspect for, specified using each protocol''s assigned internet protocol number (IANA). If not specified, this matches with any protocol. '
TCPFlags:
allOf:
- $ref: '#/components/schemas/TCPFlags'
- description: The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).
description: 'Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags. '
Dimension:
type: object
required:
- Value
properties:
Value:
allOf:
- $ref: '#/components/schemas/DimensionValue'
- description: The value to use in the custom metric dimension.
description: <p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the <code>PublishMetrics</code> <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric. </p> <p>Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the dimension value. </p> <p>For more information about CloudWatch custom metric dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions">Publishing Custom Metrics</a> in the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>
RuleGroup:
type: object
required:
- RulesSource
properties:
RuleVariables:
allOf:
- $ref: '#/components/schemas/RuleVariables'
- description: 'Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups. '
ReferenceSets:
allOf:
- $ref: '#/components/schemas/ReferenceSets'
- description: The list of a rule group's reference sets.
RulesSource:
allOf:
- $ref: '#/components/schemas/RulesSource'
- description: 'The stateful rules or stateless rules for the rule group. '
StatefulRuleOptions:
allOf:
- $ref: '#/components/schemas/StatefulRuleOptions'
- description: Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
description: <p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> <p>Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow. </p> <p>To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall. </p>
StatefulRule:
type: object
required:
- Action
- Header
- RuleOptions
properties:
Action:
allOf:
- $ref: '#/components/schemas/StatefulAction'
- description: '<p>Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow. </p> <p>The actions for a stateful rule are defined as follows: </p> <ul> <li> <p> <b>PASS</b> - Permits the packets to go to the intended destination.</p> </li> <li> <p> <b>DROP</b> - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the <a>Firewall</a> <a>LoggingConfiguration</a>. </p> </li> <li> <p> <b>ALERT</b> - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the <a>Firewall</a> <a>LoggingConfiguration</a>. </p> <p>You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with <code>ALERT</code> action, verify in the logs that the rule is filtering as you want, then change the action to <code>DROP</code>.</p> </li> <li> <p> <b>REJECT</b> - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a <code>RST</code> bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the <a>Firewall</a> <a>LoggingConfiguration</a>.</p> <p> <code>REJECT</code> isn''t currently available for use with IMAP and FTP protocols.</p> </li> </ul>'
Header:
allOf:
- $ref: '#/components/schemas/Header'
- description: 'The stateful inspection criteria for this rule, used to inspect traffic flows. '
RuleOptions:
allOf:
- $ref: '#/components/schemas/RuleOptions'
- description: Additional options for the rule. These are the Suricata <code>RuleOptions</code> settings.
description: 'A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href="https://suricata.readthedocs.iorules/intro.html#">Rules Format</
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/openapi/amazon-network-firewall-x-amz-target-networkfirewall-20201112-describerulegroup-api-openapi.yml