class Aws::NetworkFirewall::Types::CreateRuleGroupRequest
@note When making an API call, you may pass CreateRuleGroupRequest
data as a hash: { rule_group_name: "ResourceName", # required rule_group: { rule_variables: { ip_sets: { "RuleVariableName" => { definition: ["VariableDefinition"], # required }, }, port_sets: { "RuleVariableName" => { definition: ["VariableDefinition"], }, }, }, rules_source: { # required rules_string: "RulesString", rules_source_list: { targets: ["CollectionMember_String"], # required target_types: ["TLS_SNI"], # required, accepts TLS_SNI, HTTP_HOST generated_rules_type: "ALLOWLIST", # required, accepts ALLOWLIST, DENYLIST }, stateful_rules: [ { action: "PASS", # required, accepts PASS, DROP, ALERT header: { # required protocol: "IP", # required, accepts IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP source: "Source", # required source_port: "Port", # required direction: "FORWARD", # required, accepts FORWARD, ANY destination: "Destination", # required destination_port: "Port", # required }, rule_options: [ # required { keyword: "Keyword", # required settings: ["Setting"], }, ], }, ], stateless_rules_and_custom_actions: { stateless_rules: [ # required { rule_definition: { # required match_attributes: { # required sources: [ { address_definition: "AddressDefinition", # required }, ], destinations: [ { address_definition: "AddressDefinition", # required }, ], source_ports: [ { from_port: 1, # required to_port: 1, # required }, ], destination_ports: [ { from_port: 1, # required to_port: 1, # required }, ], protocols: [1], tcp_flags: [ { flags: ["FIN"], # required, accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR masks: ["FIN"], # accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR }, ], }, actions: ["CollectionMember_String"], # required }, priority: 1, # required }, ], custom_actions: [ { action_name: "ActionName", # required action_definition: { # required publish_metric_action: { dimensions: [ # required { value: "DimensionValue", # required }, ], }, }, }, ], }, }, }, rules: "RulesString", type: "STATELESS", # required, accepts STATELESS, STATEFUL description: "Description", capacity: 1, # required tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], dry_run: false, }
@!attribute [rw] rule_group_name
The descriptive name of the rule group. You can't change the name of a rule group after you create it. @return [String]
@!attribute [rw] rule_group
An object that defines the rule group rules. <note markdown="1"> You must provide either this rule group setting or a `Rules` setting, but not both. </note> @return [Types::RuleGroup]
@!attribute [rw] rules
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 markdown="1"> You must provide either this rules setting or a populated `RuleGroup` setting, but not both. </note> 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. @return [String]
@!attribute [rw] type
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. @return [String]
@!attribute [rw] description
A description of the rule group. @return [String]
@!attribute [rw] capacity
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`. <note markdown="1"> You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow. </note> **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. @return [Integer]
@!attribute [rw] tags
The key:value pairs to associate with the resource. @return [Array<Types::Tag>]
@!attribute [rw] dry_run
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. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateRuleGroupRequest AWS API Documentation
Constants
- SENSITIVE