NetworkFirewall / Client / create_rule_group
create_rule_group#
- NetworkFirewall.Client.create_rule_group(**kwargs)#
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
RuleGrouporRules.See also: AWS API Documentation
Request Syntax
response = client.create_rule_group( RuleGroupName='string', RuleGroup={ 'RuleVariables': { 'IPSets': { 'string': { 'Definition': [ 'string', ] } }, 'PortSets': { 'string': { 'Definition': [ 'string', ] } } }, 'ReferenceSets': { 'IPSetReferences': { 'string': { 'ReferenceArn': 'string' } } }, 'RulesSource': { 'RulesString': 'string', 'RulesSourceList': { 'Targets': [ 'string', ], 'TargetTypes': [ 'TLS_SNI'|'HTTP_HOST', ], 'GeneratedRulesType': 'ALLOWLIST'|'DENYLIST' }, 'StatefulRules': [ { 'Action': 'PASS'|'DROP'|'ALERT'|'REJECT', 'Header': { 'Protocol': 'IP'|'TCP'|'UDP'|'ICMP'|'HTTP'|'FTP'|'TLS'|'SMB'|'DNS'|'DCERPC'|'SSH'|'SMTP'|'IMAP'|'MSN'|'KRB5'|'IKEV2'|'TFTP'|'NTP'|'DHCP', 'Source': 'string', 'SourcePort': 'string', 'Direction': 'FORWARD'|'ANY', 'Destination': 'string', 'DestinationPort': 'string' }, 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ] }, ], 'StatelessRulesAndCustomActions': { 'StatelessRules': [ { 'RuleDefinition': { 'MatchAttributes': { 'Sources': [ { 'AddressDefinition': 'string' }, ], 'Destinations': [ { 'AddressDefinition': 'string' }, ], 'SourcePorts': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'DestinationPorts': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'Protocols': [ 123, ], 'TCPFlags': [ { 'Flags': [ 'FIN'|'SYN'|'RST'|'PSH'|'ACK'|'URG'|'ECE'|'CWR', ], 'Masks': [ 'FIN'|'SYN'|'RST'|'PSH'|'ACK'|'URG'|'ECE'|'CWR', ] }, ] }, 'Actions': [ 'string', ] }, 'Priority': 123 }, ], 'CustomActions': [ { 'ActionName': 'string', 'ActionDefinition': { 'PublishMetricAction': { 'Dimensions': [ { 'Value': 'string' }, ] } } }, ] } }, 'StatefulRuleOptions': { 'RuleOrder': 'DEFAULT_ACTION_ORDER'|'STRICT_ORDER' } }, Rules='string', Type='STATELESS'|'STATEFUL', Description='string', Capacity=123, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], DryRun=True|False, EncryptionConfiguration={ 'KeyId': 'string', 'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY' }, SourceMetadata={ 'SourceArn': 'string', 'SourceUpdateToken': 'string' }, AnalyzeRuleGroup=True|False )
- Parameters:
RuleGroupName (string) –
[REQUIRED]
The descriptive name of the rule group. You can’t change the name of a rule group after you create it.
RuleGroup (dict) –
An object that defines the rule group rules.
Note
You must provide either this rule group setting or a
Rulessetting, but not both.RuleVariables (dict) –
Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
IPSets (dict) –
A list of IP addresses and address ranges, in CIDR notation.
(string) –
(dict) –
A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
Definition (list) – [REQUIRED]
The list of IP addresses and address ranges, in CIDR notation.
(string) –
PortSets (dict) –
A list of port ranges.
(string) –
(dict) –
A set of port ranges for use in the rules in a rule group.
Definition (list) –
The set of port ranges.
(string) –
ReferenceSets (dict) –
The list of a rule group’s reference sets.
IPSetReferences (dict) –
The list of IP set references.
(string) –
(dict) –
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.
ReferenceArn (string) –
The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
RulesSource (dict) – [REQUIRED]
The stateful rules or stateless rules for the rule group.
RulesString (string) –
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.
Note
You can’t use the
prioritykeyword if theRuleOrderoption in StatefulRuleOptions is set toSTRICT_ORDER.RulesSourceList (dict) –
Stateful inspection criteria for a domain list rule group.
Targets (list) – [REQUIRED]
The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
Explicit names. For example,
abc.example.commatches only the domainabc.example.com.Names that use a domain wildcard, which you indicate with an initial ‘
.’. For example,.example.commatchesexample.comand matches all subdomains ofexample.com, such asabc.example.comandwww.example.com.
(string) –
TargetTypes (list) – [REQUIRED]
The protocols you want to inspect. Specify
TLS_SNIforHTTPS. SpecifyHTTP_HOSTforHTTP. You can specify either or both.(string) –
GeneratedRulesType (string) – [REQUIRED]
Whether you want to allow or deny access to the domains in your target list.
StatefulRules (list) –
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
Rulesformat, see Rules Format.(dict) –
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
Rulesformat, see Rules Format.Action (string) – [REQUIRED]
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
ALERTaction, verify in the logs that the rule is filtering as you want, then change the action toDROP.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 (dict) – [REQUIRED]
The stateful inspection criteria for this rule, used to inspect traffic flows.
Protocol (string) – [REQUIRED]
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 (string) – [REQUIRED]
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 (string) – [REQUIRED]
The source port to inspect for. You can specify an individual port, for example
1994and you can specify a port range, for example1990:1994. To match with any port, specifyANY.Direction (string) – [REQUIRED]
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 toFORWARD, the inspection only matches traffic going from the source to the destination.Destination (string) – [REQUIRED]
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 (string) – [REQUIRED]
The destination port to inspect for. You can specify an individual port, for example
1994and you can specify a port range, for example1990:1994. To match with any port, specifyANY.
RuleOptions (list) – [REQUIRED]
Additional options for the rule. These are the Suricata
RuleOptionssettings.(dict) –
Additional settings for a stateful rule. This is part of the StatefulRule configuration.
Keyword (string) – [REQUIRED]
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 (list) –
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.(string) –
StatelessRulesAndCustomActions (dict) –
Stateless inspection criteria to be used in a stateless rule group.
StatelessRules (list) – [REQUIRED]
Defines the set of stateless rules for use in a stateless rule group.
(dict) –
A single stateless rule. This is used in StatelessRulesAndCustomActions.
RuleDefinition (dict) – [REQUIRED]
Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
MatchAttributes (dict) – [REQUIRED]
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.
Sources (list) –
The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
(dict) –
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) – [REQUIRED]
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.
Destinations (list) –
The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
(dict) –
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) – [REQUIRED]
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.
SourcePorts (list) –
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
1994and you can specify port ranges, for example1990:1994.(dict) –
A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes,
SourcePorts, andDestinationPortssettings.FromPort (integer) – [REQUIRED]
The lower limit of the port range. This must be less than or equal to the
ToPortspecification.ToPort (integer) – [REQUIRED]
The upper limit of the port range. This must be greater than or equal to the
FromPortspecification.
DestinationPorts (list) –
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
1994and you can specify port ranges, for example1990:1994.(dict) –
A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes,
SourcePorts, andDestinationPortssettings.FromPort (integer) – [REQUIRED]
The lower limit of the port range. This must be less than or equal to the
ToPortspecification.ToPort (integer) – [REQUIRED]
The upper limit of the port range. This must be greater than or equal to the
FromPortspecification.
Protocols (list) –
The protocols to inspect for, specified using each protocol’s assigned internet protocol number (IANA). If not specified, this matches with any protocol.
(integer) –
TCPFlags (list) –
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).
(dict) –
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
Flags (list) – [REQUIRED]
Used in conjunction with the
Maskssetting 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 theMaskssetting.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.
(string) –
Masks (list) –
The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
(string) –
Actions (list) – [REQUIRED]
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.
Note
Network Firewall only forwards a packet for stateful rule inspection if you specify
aws:forward_to_sfefor a rule that the packet matches, or if the packet doesn’t match any stateless rule and you specifyaws:forward_to_sfefor theStatelessDefaultActionssetting 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
Actionssetting. 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
PublishMetricsaction that you’ve namedMyMetricsAction, then you could specify the standard actionaws:passand the custom action with[“aws:pass”, “MyMetricsAction”].(string) –
Priority (integer) – [REQUIRED]
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
StatelessRulesAndCustomActionsobject, and eachStatelessRulesAndCustomActionscontains exactly oneStatelessRulesobject. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRulesobject.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.
CustomActions (list) –
Defines an array of individual custom action definitions that are available for use by the stateless rules in this
StatelessRulesAndCustomActionsspecification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinitionActionsspecification.(dict) –
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
StatelessRulesAndCustomActionswhere 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.
ActionName (string) – [REQUIRED]
The descriptive name of the custom action. You can’t change the name of a custom action after you create it.
ActionDefinition (dict) – [REQUIRED]
The custom action associated with the action name.
PublishMetricAction (dict) –
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 (list) – [REQUIRED]
(dict) –
The value to use in an Amazon CloudWatch custom metric dimension. This is used in the
PublishMetricsCustomAction. 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
CustomActionand you provide the dimension value.For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
Value (string) – [REQUIRED]
The value to use in the custom metric dimension.
StatefulRuleOptions (dict) –
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.
RuleOrder (string) –
Indicates how to manage the order of the rule evaluation for the rule group.
DEFAULT_ACTION_ORDERis 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.
Rules (string) –
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.
Note
You must provide either this rules setting or a populated
RuleGroupsetting, 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 (string) –
[REQUIRED]
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 (string) – A description of the rule group.
Capacity (integer) –
[REQUIRED]
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
DryRunset toTRUE.Note
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
Anyspecified 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 (list) –
The key:value pairs to associate with the resource.
(dict) –
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) – [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.
Value (string) – [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.
DryRun (boolean) –
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 toFALSE, 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.EncryptionConfiguration (dict) –
A complex type that contains settings for encryption of your rule group resources.
KeyId (string) –
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 (string) – [REQUIRED]
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
SourceMetadata (dict) –
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
SourceArn (string) –
The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken (string) –
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.
AnalyzeRuleGroup (boolean) – Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, setDryRuntoTRUE.
- Return type:
dict
- Returns:
Response Syntax
{ 'UpdateToken': 'string', 'RuleGroupResponse': { 'RuleGroupArn': 'string', 'RuleGroupName': 'string', 'RuleGroupId': 'string', 'Description': 'string', 'Type': 'STATELESS'|'STATEFUL', 'Capacity': 123, 'RuleGroupStatus': 'ACTIVE'|'DELETING'|'ERROR', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConsumedCapacity': 123, 'NumberOfAssociations': 123, 'EncryptionConfiguration': { 'KeyId': 'string', 'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY' }, 'SourceMetadata': { 'SourceArn': 'string', 'SourceUpdateToken': 'string' }, 'SnsTopic': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'AnalysisResults': [ { 'IdentifiedRuleIds': [ 'string', ], 'IdentifiedType': 'STATELESS_RULE_FORWARDING_ASYMMETRICALLY'|'STATELESS_RULE_CONTAINS_TCP_FLAGS', 'AnalysisDetail': 'string' }, ] } }
Response Structure
(dict) –
UpdateToken (string) –
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.RuleGroupResponse (dict) –
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.
RuleGroupArn (string) –
The Amazon Resource Name (ARN) of the rule group.
Note
If this response is for a create request that had
DryRunset toTRUE, then this ARN is a placeholder that isn’t attached to a valid resource.RuleGroupName (string) –
The descriptive name of the rule group. You can’t change the name of a rule group after you create it.
RuleGroupId (string) –
The unique identifier for the rule group.
Description (string) –
A description of the rule group.
Type (string) –
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.
Capacity (integer) –
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
DryRunset toTRUE.RuleGroupStatus (string) –
Detailed information about the current status of a rule group.
Tags (list) –
The key:value pairs to associate with the resource.
(dict) –
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) –
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.
Value (string) –
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.
ConsumedCapacity (integer) –
The number of capacity units currently consumed by the rule group rules.
NumberOfAssociations (integer) –
The number of firewall policies that use this rule group.
EncryptionConfiguration (dict) –
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
KeyId (string) –
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 (string) –
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
SourceMetadata (dict) –
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.
SourceArn (string) –
The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken (string) –
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.
SnsTopic (string) –
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..
LastModifiedTime (datetime) –
The last time that the rule group was changed.
AnalysisResults (list) –
The list of analysis results for
AnalyzeRuleGroup. If you setAnalyzeRuleGrouptoTRUEin 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.(dict) –
The analysis result for Network Firewall’s stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account 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 a list of analysis results.
IdentifiedRuleIds (list) –
The priority number of the stateless rules identified in the analysis.
(string) –
IdentifiedType (string) –
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_ASYMMETRICALLYCause: One or more stateless rules with the actionpassorforwardare 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_FLAGSCause: At least one stateless rule with the actionpassorforwardcontains 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
SYNandACKflags used in a 3-way TCP handshake.
AnalysisDetail (string) –
Provides analysis details for the identified rule.
Exceptions
NetworkFirewall.Client.exceptions.LimitExceededExceptionNetworkFirewall.Client.exceptions.InvalidRequestExceptionNetworkFirewall.Client.exceptions.ThrottlingExceptionNetworkFirewall.Client.exceptions.InternalServerErrorNetworkFirewall.Client.exceptions.InsufficientCapacityException