This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!aws_network_firewall_rule_group
account_id
Type: STRING
rule_group
Type: STRUCT
Provider name: RuleGroup
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.
reference_sets
Type: STRUCT
Provider name: ReferenceSets
Description: The list of a rule group’s reference sets.
ip_set_references
Type: STRING
Provider name: IPSetReferences
Description: The list of IP set references.
rule_variables
Type: STRUCT
Provider name: RuleVariables
Description: Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
ip_sets
Type: STRING
Provider name: IPSets
Description: A list of IP addresses and address ranges, in CIDR notation.
port_sets
Type: STRING
Provider name: PortSets
Description: A list of port ranges.
rules_source
Type: STRUCT
Provider name: RulesSource
Description: The stateful rules or stateless rules for the rule group.
rules_source_list
Type: STRUCT
Provider name: RulesSourceList
Description: Stateful inspection criteria for a domain list rule group.
generated_rules_type
Type: STRING
Provider name: GeneratedRulesType
Description: Whether you want to allow or deny access to the domains in your target list.
target_types
Type: UNORDERED_LIST_STRING
Provider name: TargetTypes
Description: The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.
targets
Type: UNORDERED_LIST_STRING
Provider name: Targets
Description: 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.
rules_string
Type: STRING
Provider name: RulesString
Description: Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework 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. You can’t use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.
stateful_rules
Type: UNORDERED_LIST_STRUCT
Provider name: 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 Rules format, see Rules Format.
action
Type: STRING
Provider name: Action
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 - 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 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 an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn’t support FTP or IMAP protocols.
header
Type: STRUCT
Provider name: Header
Description: The stateful inspection criteria for this rule, used to inspect traffic flows.
destination
Type: STRING
Provider name: 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.
destination_port
Type: STRING
Provider name: DestinationPort
Description: The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
direction
Type: STRING
Provider name: Direction
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.
protocol
Type: STRING
Provider name: Protocol
Description: The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.
source
Type: STRING
Provider name: 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.
source_port
Type: STRING
Provider name: SourcePort
Description: The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
rule_options
Type: UNORDERED_LIST_STRUCT
Provider name: RuleOptions
Description: Additional options for the rule. These are the Suricata RuleOptions settings.
keyword
Type: STRING
Provider name: Keyword
Description: The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.
settings
Type: UNORDERED_LIST_STRING
Provider name: Settings
Description: The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.
stateless_rules_and_custom_actions
Type: STRUCT
Provider name: StatelessRulesAndCustomActions
Description: Stateless inspection criteria to be used in a stateless rule group.
custom_actions
Type: UNORDERED_LIST_STRUCT
Provider name: CustomActions
Description: Defines an array of individual custom action definitions that are available for use by the stateless rules in this StatelessRulesAndCustomActions specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinition Actions specification.
action_definition
Type: STRUCT
Provider name: ActionDefinition
Description: The custom action associated with the action name.
publish_metric_action
Type: STRUCT
Provider name: 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.
dimensions
Type: UNORDERED_LIST_STRUCT
Provider name: Dimensions
Description:
value
Type: STRING
Provider name: Value
Description: The value to use in the custom metric dimension.
action_name
Type: STRING
Provider name: ActionName
Description: The descriptive name of the custom action. You can’t change the name of a custom action after you create it.
stateless_rules
Type: UNORDERED_LIST_STRUCT
Provider name: StatelessRules
Description: Defines the set of stateless rules for use in a stateless rule group.
priority
Type: INT32
Provider name: Priority
Description: 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.
rule_definition
Type: STRUCT
Provider name: RuleDefinition
Description: Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
actions
Type: UNORDERED_LIST_STRING
Provider name: Actions
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”].
match_attributes
Type: STRUCT
Provider name: 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.
destination_ports
Type: UNORDERED_LIST_STRUCT
Provider name: DestinationPorts
Description: 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.
from_port
Type: INT32
Provider name: FromPort
Description: The lower limit of the port range. This must be less than or equal to the ToPort specification.
to_port
Type: INT32
Provider name: ToPort
Description: The upper limit of the port range. This must be greater than or equal to the FromPort specification.
destinations
Type: UNORDERED_LIST_STRUCT
Provider name: Destinations
Description: The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
address_definition
Type: STRING
Provider name: 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.
protocols
Type: UNORDERED_LIST_INT32
Provider name: Protocols
Description: The protocols to inspect for, specified using each protocol’s assigned internet protocol number (IANA). If not specified, this matches with any protocol.
source_ports
Type: UNORDERED_LIST_STRUCT
Provider name: SourcePorts
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.
from_port
Type: INT32
Provider name: FromPort
Description: The lower limit of the port range. This must be less than or equal to the ToPort specification.
to_port
Type: INT32
Provider name: ToPort
Description: The upper limit of the port range. This must be greater than or equal to the FromPort specification.
sources
Type: UNORDERED_LIST_STRUCT
Provider name: Sources
Description: The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
address_definition
Type: STRING
Provider name: 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.
tcp_flags
Type: UNORDERED_LIST_STRUCT
Provider name: 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).
flags
Type: UNORDERED_LIST_STRING
Provider name: Flags
Description: 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.
masks
Type: UNORDERED_LIST_STRING
Provider name: Masks
Description: The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
stateful_rule_options
Type: STRUCT
Provider name: 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. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.
rule_order
Type: STRING
Provider name: RuleOrder
Description: Indicates how to manage the order of the rule evaluation for the rule group. 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.
rule_group_arn
Type: STRING
rule_group_response
Type: STRUCT
Provider name: RuleGroupResponse
Description: The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
analysis_results
Type: UNORDERED_LIST_STRUCT
Provider name: AnalysisResults
Description: The list of analysis results for AnalyzeRuleGroup. If you set AnalyzeRuleGroup to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall’s functionality. For example, if Network Firewall detects a rule that’s routing traffic asymmetrically, which impacts the service’s ability to properly process traffic, the service includes the rule in the list of analysis results.
analysis_detail
Type: STRING
Provider name: AnalysisDetail
Description: Provides analysis details for the identified rule.
identified_rule_ids
Type: UNORDERED_LIST_STRING
Provider name: IdentifiedRuleIds
Description: The priority number of the stateless rules identified in the analysis.
identified_type
Type: STRING
Provider name: IdentifiedType
Description: The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:STATELESS_RULE_FORWARDING_ASYMMETRICALLY Cause: One or more stateless rules with the action pass or forward are forwarding traffic asymmetrically. Specifically, the rule’s set of source IP addresses or their associated port numbers, don’t match the set of destination IP addresses or their associated port numbers. To mitigate: Make sure that there’s an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.STATELESS_RULE_CONTAINS_TCP_FLAGS Cause: At least one stateless rule with the action pass orforward contains TCP flags that are inconsistent in the forward and return directions. To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:- Remove unnecessary TCP flag inspections from the rules.
- If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example
SYN and ACK flags used in a 3-way TCP handshake.
capacity
Type: INT32
Provider name: Capacity
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.
consumed_capacity
Type: INT32
Provider name: ConsumedCapacity
Description: The number of capacity units currently consumed by the rule group rules.
description
Type: STRING
Provider name: Description
Description: A description of the rule group.
encryption_configuration
Type: STRUCT
Provider name: EncryptionConfiguration
Description: A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
key_id
Type: STRING
Provider name: KeyId
Description: The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you’re using a key that’s managed by another account. If you’re using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
type
Type: STRING
Provider name: Type
Description: The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
last_modified_time
Type: TIMESTAMP
Provider name: LastModifiedTime
Description: The last time that the rule group was changed.
number_of_associations
Type: INT32
Provider name: NumberOfAssociations
Description: The number of firewall policies that use this rule group.
rule_group_arn
Type: STRING
Provider name: RuleGroupArn
Description: 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.
rule_group_id
Type: STRING
Provider name: RuleGroupId
Description: The unique identifier for the rule group.
rule_group_name
Type: STRING
Provider name: RuleGroupName
Description: The descriptive name of the rule group. You can’t change the name of a rule group after you create it.
rule_group_status
Type: STRING
Provider name: RuleGroupStatus
Description: Detailed information about the current status of a rule group.
sns_topic
Type: STRING
Provider name: SnsTopic
Description: The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
source_metadata
Type: STRUCT
Provider name: SourceMetadata
Description: A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
source_arn
Type: STRING
Provider name: SourceArn
Description: The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
type
Type: STRING
Provider name: Type
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.
Type: UNORDERED_LIST_STRING
