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.
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 Amazon Web Services APIs.
To access Network Firewall using the REST API endpoint: https://network-firewall.<region>.amazonaws.com
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 Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
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 Suricata website.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
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 Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don''t already have a VPC that you want to protect, create it in Amazon VPC.
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.
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.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
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.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either RuleGroup or Rules.
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.
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.
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 SuricataRules format, see Rules Format. '
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 RulesSource. 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
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 RuleGroup 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: '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.
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.
You can use custom actions in the following places:
In a rule group''s StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions 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.
In a FirewallPolicy specification, in StatelessCustomActions. 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.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
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.
Each stateless rule group uses exactly one StatelessRulesAndCustomActions object, and each StatelessRulesAndCustomActions contains exactly one StatelessRules object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single StatelessRules object.
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.
description: A single stateless rule. This is used in StatelessRulesAndCustomActions. 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:Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. 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 Using IP set references in the Network Firewall Developer Guide.
Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.
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 thisStatelessRulesAndCustomActions specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinition Actions 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: 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.
Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
For every rule, you must specify exactly one of the following standard actions.
aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
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 Actions setting. For information about the options, see CustomAction.
To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
DEFAULT_ACTION_ORDER 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 Evaluation order for stateful rules in the Network Firewall Developer Guide. '
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: 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).
You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990:1994.
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).
You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990:1994.
The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
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:The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
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.
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.
StatefulRule: type: object required: - Action - Header - RuleOptions properties: Action: allOf: - $ref: '#/components/schemas/StatefulAction' - description: '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.
The actions for a stateful rule are defined as follows:
PASS - Permits the packets to go to the intended destination.
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
ALERT - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
REJECT - 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 RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration.
REJECT isn''t currently available for use with IMAP and FTP protocols.
RuleOptions 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 Rules format, see Rules Format. '
IPSet:
type: object
required:
- Definition
properties:
Definition:
allOf:
- $ref: '#/components/schemas/VariableDefinitionList'
- description: 'The list of IP addresses and address ranges, in CIDR notation. '
description: 'A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables. '
Address:
type: object
required:
- AddressDefinition
properties:
AddressDefinition:
allOf:
- $ref: '#/components/schemas/AddressDefinition'
- description: 'Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
' description: A single IP address specification. This is used in the MatchAttributes source and destination specifications. TagKey: type: string pattern: ^.*$ minLength: 1 maxLength: 128 Header: type: object required: - Protocol - Source - SourcePort - Direction - Destination - DestinationPort properties: Protocol: allOf: - $ref: '#/components/schemas/StatefulRuleProtocol' - description: The protocol to inspect for. To specify all, you can useIP, because all traffic on Amazon Web Services and on the internet is IP.
Source:
allOf:
- $ref: '#/components/schemas/Source'
- description: 'The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
' SourcePort: allOf: - $ref: '#/components/schemas/Port' - description: 'The source port to inspect for. You can specify an individual port, for example1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY. '
Direction:
allOf:
- $ref: '#/components/schemas/StatefulRuleDirection'
- description: 'The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination. '
Destination:
allOf:
- $ref: '#/components/schemas/Destination'
- description: 'The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
' DestinationPort: allOf: - $ref: '#/components/schemas/Port' - description: 'The destination port to inspect for. You can specify an individual port, for example1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY. '
description: 'The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule. '
StatefulAction:
type: string
enum:
- PASS
- DROP
- ALERT
- REJECT
VariableDefinition:
type: string
pattern: ^.*$
minLength: 1
PortRange:
type: object
required:
- FromPort
- ToPort
properties:
FromPort:
allOf:
- $ref: '#/components/schemas/PortRangeBound'
- description: 'The lower limit of the port range. This must be less than or equal to the ToPort specification. '
ToPort:
allOf:
- $ref: '#/components/schemas/PortRangeBound'
- description: 'The upper limit of the port range. This must be greater than or equal to the FromPort specification. '
description: 'A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings. '
RulesString:
type: string
minLength: 0
maxLength: 2000000
InvalidRequestException: {}
InternalServerError: {}
LimitExceededException: {}
SourceMetadata:
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 DescribeRuleGroup.
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 DescribeRuleGroup.
StatelessActions:
type: array
items:
$ref: '#/components/schemas/CollectionMember_String'
ActionDefinition:
type: object
properties:
PublishMetricAction:
allOf:
- $ref: '#/components/schemas/PublishMetricAction'
- description: Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
description: A custom action to use in stateless rule actions settings. This is used in CustomAction. TCPFlags: type: array items: $ref: '#/components/schemas/TCPFlagField' Port: type: string pattern: ^.*$ minLength: 1 maxLength: 1024 ResourceName: type: string pattern: ^[a-zA-Z0-9-]+$ minLength: 1 maxLength: 128 CreateRuleGroupRequest: type: object required: - RuleGroupName - Type - Capacity title: CreateRuleGroupRequest properties: RuleGroupName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The descriptive name of the rule group. You can't change the name of a rule group after you create it. RuleGroup: allOf: - $ref: '#/components/schemas/RuleGroup' - description:An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
Type: allOf: - $ref: '#/components/schemas/RuleGroupType' - description: '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. ' Description: allOf: - $ref: '#/components/schemas/Description' - description: 'A description of the rule group. ' Capacity: allOf: - $ref: '#/components/schemas/RuleCapacity' - description:The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
Tags: allOf: - $ref: '#/components/schemas/TagList' - description: The key:value pairs to associate with the resource. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description:Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
For the flags that are specified in the masks setting, the following must be true for the packet to match:
The ones that are set in this flags setting must be set in the packet.
The ones that are not set in this flags setting must also not be set in the packet.
The Amazon Resource Name (ARN) of the rule group.
If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
Explicit names. For example, abc.example.com matches only the domain abc.example.com.
Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.
TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both. '
GeneratedRulesType:
allOf:
- $ref: '#/components/schemas/GeneratedRulesType'
- description: Whether you want to allow or deny access to the domains in your target list.
description: Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.