AWS Native is in preview. AWS Classic is fully supported.
aws-native.networkfirewall.getRuleGroup
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource type definition for AWS::NetworkFirewall::RuleGroup
Using getRuleGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRuleGroup(args: GetRuleGroupArgs, opts?: InvokeOptions): Promise<GetRuleGroupResult>
function getRuleGroupOutput(args: GetRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetRuleGroupResult>
def get_rule_group(rule_group_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRuleGroupResult
def get_rule_group_output(rule_group_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRuleGroupResult]
func LookupRuleGroup(ctx *Context, args *LookupRuleGroupArgs, opts ...InvokeOption) (*LookupRuleGroupResult, error)
func LookupRuleGroupOutput(ctx *Context, args *LookupRuleGroupOutputArgs, opts ...InvokeOption) LookupRuleGroupResultOutput
> Note: This function is named LookupRuleGroup
in the Go SDK.
public static class GetRuleGroup
{
public static Task<GetRuleGroupResult> InvokeAsync(GetRuleGroupArgs args, InvokeOptions? opts = null)
public static Output<GetRuleGroupResult> Invoke(GetRuleGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRuleGroupResult> getRuleGroup(GetRuleGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:networkfirewall:getRuleGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
.
- Rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
.
- rule
Group StringArn - The Amazon Resource Name (ARN) of the
RuleGroup
.
- rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
.
- rule_
group_ strarn - The Amazon Resource Name (ARN) of the
RuleGroup
.
- rule
Group StringArn - The Amazon Resource Name (ARN) of the
RuleGroup
.
getRuleGroup Result
The following output properties are available:
- Description string
- A description of the rule group.
- Rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
. - Rule
Group stringId - The unique ID of the
RuleGroup
resource. - Rule
Group Pulumi.Value Aws Native. Network Firewall. Outputs. Rule Group - An object that defines the rule group rules.
- List<Pulumi.
Aws Native. Outputs. Tag> An array of key-value pairs to apply to this resource.
For more information, see Tag .
- Description string
- A description of the rule group.
- Rule
Group RuleGroup Type - An object that defines the rule group rules.
- Rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
. - Rule
Group stringId - The unique ID of the
RuleGroup
resource. - Tag
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- description String
- A description of the rule group.
- rule
Group RuleGroup - An object that defines the rule group rules.
- rule
Group StringArn - The Amazon Resource Name (ARN) of the
RuleGroup
. - rule
Group StringId - The unique ID of the
RuleGroup
resource. - List<Tag>
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- description string
- A description of the rule group.
- rule
Group RuleGroup - An object that defines the rule group rules.
- rule
Group stringArn - The Amazon Resource Name (ARN) of the
RuleGroup
. - rule
Group stringId - The unique ID of the
RuleGroup
resource. - Tag[]
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- description str
- A description of the rule group.
- rule_
group RuleGroup - An object that defines the rule group rules.
- rule_
group_ strarn - The Amazon Resource Name (ARN) of the
RuleGroup
. - rule_
group_ strid - The unique ID of the
RuleGroup
resource. - Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- description String
- A description of the rule group.
- rule
Group Property Map - An object that defines the rule group rules.
- rule
Group StringArn - The Amazon Resource Name (ARN) of the
RuleGroup
. - rule
Group StringId - The unique ID of the
RuleGroup
resource. - List<Property Map>
An array of key-value pairs to apply to this resource.
For more information, see Tag .
Supporting Types
RuleGroup
- Rules
Source Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Rules Source - The stateful rules or stateless rules for the rule group.
- Reference
Sets Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Reference Sets - The reference sets for the stateful rule group.
- Rule
Variables Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Rule Variables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- Stateful
Rule Pulumi.Options Aws Native. Network Firewall. Inputs. Rule Group Stateful Rule Options - 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 AWS Network Firewall Developer Guide .
- Rules
Source RuleGroup Rules Source - The stateful rules or stateless rules for the rule group.
- Reference
Sets RuleGroup Reference Sets - The reference sets for the stateful rule group.
- Rule
Variables RuleGroup Rule Variables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- Stateful
Rule RuleOptions Group Stateful Rule Options - 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 AWS Network Firewall Developer Guide .
- rules
Source RuleGroup Rules Source - The stateful rules or stateless rules for the rule group.
- reference
Sets RuleGroup Reference Sets - The reference sets for the stateful rule group.
- rule
Variables RuleGroup Rule Variables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- stateful
Rule RuleOptions Group Stateful Rule Options - 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 AWS Network Firewall Developer Guide .
- rules
Source RuleGroup Rules Source - The stateful rules or stateless rules for the rule group.
- reference
Sets RuleGroup Reference Sets - The reference sets for the stateful rule group.
- rule
Variables RuleGroup Rule Variables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- stateful
Rule RuleOptions Group Stateful Rule Options - 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 AWS Network Firewall Developer Guide .
- rules_
source RuleGroup Rules Source - The stateful rules or stateless rules for the rule group.
- reference_
sets RuleGroup Reference Sets - The reference sets for the stateful rule group.
- rule_
variables RuleGroup Rule Variables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- stateful_
rule_ Ruleoptions Group Stateful Rule Options - 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 AWS Network Firewall Developer Guide .
- rules
Source Property Map - The stateful rules or stateless rules for the rule group.
- reference
Sets Property Map - The reference sets for the stateful rule group.
- rule
Variables Property Map - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- stateful
Rule Property MapOptions - 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 AWS Network Firewall Developer Guide .
RuleGroupActionDefinition
- Publish
Metric Pulumi.Action Aws Native. Network Firewall. Inputs. Rule Group Publish Metric Action 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.
- Publish
Metric RuleAction Group Publish Metric Action 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.
- publish
Metric RuleAction Group Publish Metric Action 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.
- publish
Metric RuleAction Group Publish Metric Action 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.
- publish_
metric_ Ruleaction Group Publish Metric Action 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.
- publish
Metric Property MapAction 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.
RuleGroupAddress
- Address
Definition string 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- Address
Definition string 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- address
Definition String 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- address
Definition string 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- address_
definition str 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- address
Definition String 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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
RuleGroupCustomAction
- Action
Definition Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Action Definition - The custom action associated with the action name.
- Action
Name string - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- Action
Definition RuleGroup Action Definition - The custom action associated with the action name.
- Action
Name string - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- action
Definition RuleGroup Action Definition - The custom action associated with the action name.
- action
Name String - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- action
Definition RuleGroup Action Definition - The custom action associated with the action name.
- action
Name string - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- action_
definition RuleGroup Action Definition - The custom action associated with the action name.
- action_
name str - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- action
Definition Property Map - The custom action associated with the action name.
- action
Name String - The descriptive name of the custom action. You can't change the name of a custom action after you create it.
RuleGroupDimension
- Value string
- The value to use in the custom metric dimension.
- Value string
- The value to use in the custom metric dimension.
- value String
- The value to use in the custom metric dimension.
- value string
- The value to use in the custom metric dimension.
- value str
- The value to use in the custom metric dimension.
- value String
- The value to use in the custom metric dimension.
RuleGroupGeneratedRulesType
RuleGroupHeader
- Destination string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- Destination
Port string - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - Direction
Pulumi.
Aws Native. Network Firewall. Rule Group Header Direction - 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. - Protocol
Pulumi.
Aws Native. Network Firewall. Rule Group Header Protocol - The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - Source string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- Source
Port string - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
- Destination string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- Destination
Port string - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - Direction
Rule
Group Header Direction - 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. - Protocol
Rule
Group Header Protocol - The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - Source string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- Source
Port string - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
- destination String
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- destination
Port String - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - direction
Rule
Group Header Direction - 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. - protocol
Rule
Group Header Protocol - The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - source String
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- source
Port String - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
- destination string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- destination
Port string - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - direction
Rule
Group Header Direction - 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. - protocol
Rule
Group Header Protocol - The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - source string
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- source
Port string - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
- destination str
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- destination_
port str - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - direction
Rule
Group Header Direction - 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. - protocol
Rule
Group Header Protocol - The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - source str
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- source_
port str - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
- destination String
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- destination
Port String - The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
. - direction "FORWARD" | "ANY"
- 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. - protocol "IP" | "TCP" | "UDP" | "ICMP" | "HTTP" | "FTP" | "TLS" | "SMB" | "DNS" | "DCERPC" | "SSH" | "SMTP" | "IMAP" | "MSN" | "KRB5" | "IKEV2" | "TFTP" | "NTP" | "DHCP"
- The protocol to inspect for. To specify all, you can use
IP
, because all traffic on AWS and on the internet is IP. - source String
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 .
- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
- source
Port String - The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
RuleGroupHeaderDirection
RuleGroupHeaderProtocol
RuleGroupIpSet
- Definition List<string>
- Definition []string
- definition List<String>
- definition string[]
- definition Sequence[str]
- definition List<String>
RuleGroupIpSetReference
- Reference
Arn string
- Reference
Arn string
- reference
Arn String
- reference
Arn string
- reference_
arn str
- reference
Arn String
RuleGroupMatchAttributes
- Destination
Ports List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Port Range> 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 example1990:1994
.- Destinations
List<Pulumi.
Aws Native. Network Firewall. Inputs. Rule Group Address> - The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- Protocols List<int>
- 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 List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Port Range> 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 example1990:1994
.- Sources
List<Pulumi.
Aws Native. Network Firewall. Inputs. Rule Group Address> - The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- Tcp
Flags List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Tcp Flag Field> - 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).
- Destination
Ports []RuleGroup Port Range 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 example1990:1994
.- Destinations
[]Rule
Group Address - The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- Protocols []int
- 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 []RuleGroup Port Range 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 example1990:1994
.- Sources
[]Rule
Group Address - The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- Tcp
Flags []RuleGroup Tcp Flag Field - 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).
- destination
Ports List<RuleGroup Port Range> 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 example1990:1994
.- destinations
List<Rule
Group Address> - The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- protocols List<Integer>
- 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 List<RuleGroup Port Range> 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 example1990:1994
.- sources
List<Rule
Group Address> - The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- tcp
Flags List<RuleGroup Tcp Flag Field> - 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).
- destination
Ports RuleGroup Port Range[] 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 example1990:1994
.- destinations
Rule
Group Address[] - The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- protocols number[]
- 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 RuleGroup Port Range[] 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 example1990:1994
.- sources
Rule
Group Address[] - The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- tcp
Flags RuleGroup Tcp Flag Field[] - 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).
- destination_
ports Sequence[RuleGroup Port Range] 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 example1990:1994
.- destinations
Sequence[Rule
Group Address] - The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- protocols Sequence[int]
- 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 Sequence[RuleGroup Port Range] 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 example1990:1994
.- sources
Sequence[Rule
Group Address] - The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- tcp_
flags Sequence[RuleGroup Tcp Flag Field] - 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).
- destination
Ports List<Property Map> 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 example1990:1994
.- destinations List<Property Map>
- The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- protocols List<Number>
- 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 List<Property Map> 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 example1990:1994
.- sources List<Property Map>
- The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- tcp
Flags List<Property Map> - 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).
RuleGroupPortRange
RuleGroupPortSet
- Definition List<string>
- Definition []string
- definition List<String>
- definition string[]
- definition Sequence[str]
- definition List<String>
RuleGroupPublishMetricAction
RuleGroupReferenceSets
- Ip
Set Dictionary<string, Pulumi.References Aws Native. Network Firewall. Inputs. Rule Group Ip Set Reference> - The IP set references to use in the stateful rule group.
- Ip
Set map[string]RuleReferences Group Ip Set Reference - The IP set references to use in the stateful rule group.
- ip
Set Map<String,RuleReferences Group Ip Set Reference> - The IP set references to use in the stateful rule group.
- ip
Set {[key: string]: RuleReferences Group Ip Set Reference} - The IP set references to use in the stateful rule group.
- ip_
set_ Mapping[str, Rulereferences Group Ip Set Reference] - The IP set references to use in the stateful rule group.
- ip
Set Map<Property Map>References - The IP set references to use in the stateful rule group.
RuleGroupRuleDefinition
- Actions List<string>
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- Match
Attributes Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Match Attributes - 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 []string
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- Match
Attributes RuleGroup Match Attributes - 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 List<String>
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- match
Attributes RuleGroup Match Attributes - 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 string[]
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- match
Attributes RuleGroup Match Attributes - 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 Sequence[str]
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- match_
attributes RuleGroup Match Attributes - 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 List<String>
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for theFirewallPolicy
.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.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named
MyMetricsAction
, then you could specify the standard actionaws:pass
combined with the custom action using["aws:pass", "MyMetricsAction"]
.- match
Attributes Property Map - 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.
RuleGroupRuleOption
- Keyword string
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - Settings List<string>
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
- Keyword string
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - Settings []string
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
- keyword String
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - settings List<String>
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
- keyword string
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - settings string[]
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
- keyword str
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - settings Sequence[str]
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
- keyword String
- The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format
sid:112233
. The sid must be unique within the rule group. For information about Suricata rule option keywords, see Rule options . - settings List<String>
- The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is
number
. For information about Suricata rule option settings, see Rule options .
RuleGroupRuleOrder
RuleGroupRuleVariables
RuleGroupRulesSource
- Rules
Source Pulumi.List Aws Native. Network Firewall. Inputs. Rule Group Rules Source List - Stateful inspection criteria for a domain list rule group.
- Rules
String 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.
You can't use the
priority
keyword if theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- Stateful
Rules List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Stateful Rule> - 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 . - Stateless
Rules Pulumi.And Custom Actions Aws Native. Network Firewall. Inputs. Rule Group Stateless Rules And Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
- Rules
Source RuleList Group Rules Source List - Stateful inspection criteria for a domain list rule group.
- Rules
String 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.
You can't use the
priority
keyword if theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- Stateful
Rules []RuleGroup Stateful Rule - 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 . - Stateless
Rules RuleAnd Custom Actions Group Stateless Rules And Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
- rules
Source RuleList Group Rules Source List - Stateful inspection criteria for a domain list rule group.
- rules
String 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.
You can't use the
priority
keyword if theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- stateful
Rules List<RuleGroup Stateful Rule> - 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 . - stateless
Rules RuleAnd Custom Actions Group Stateless Rules And Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
- rules
Source RuleList Group Rules Source List - Stateful inspection criteria for a domain list rule group.
- rules
String 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.
You can't use the
priority
keyword if theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- stateful
Rules RuleGroup Stateful Rule[] - 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 . - stateless
Rules RuleAnd Custom Actions Group Stateless Rules And Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
- rules_
source_ Rulelist Group Rules Source List - Stateful inspection criteria for a domain list rule group.
- rules_
string str 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 theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- stateful_
rules Sequence[RuleGroup Stateful Rule] - 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 . - stateless_
rules_ Ruleand_ custom_ actions Group Stateless Rules And Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
- rules
Source Property MapList - Stateful inspection criteria for a domain list rule group.
- rules
String 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.
You can't use the
priority
keyword if theRuleOrder
option inStatefulRuleOptions
is set toSTRICT_ORDER
.- stateful
Rules List<Property Map> - 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 . - stateless
Rules Property MapAnd Custom Actions - Stateless inspection criteria to be used in a stateless rule group.
RuleGroupRulesSourceList
- Generated
Rules Pulumi.Type Aws Native. Network Firewall. Rule Group Generated Rules Type - Whether you want to allow or deny access to the domains in your target list.
- Target
Types List<Pulumi.Aws Native. Network Firewall. Rule Group Target Type> - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - Targets List<string>
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
- Generated
Rules RuleType Group Generated Rules Type - Whether you want to allow or deny access to the domains in your target list.
- Target
Types []RuleGroup Target Type - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - Targets []string
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
- generated
Rules RuleType Group Generated Rules Type - Whether you want to allow or deny access to the domains in your target list.
- target
Types List<RuleGroup Target Type> - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - targets List<String>
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
- generated
Rules RuleType Group Generated Rules Type - Whether you want to allow or deny access to the domains in your target list.
- target
Types RuleGroup Target Type[] - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - targets string[]
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
- generated_
rules_ Ruletype Group Generated Rules Type - Whether you want to allow or deny access to the domains in your target list.
- target_
types Sequence[RuleGroup Target Type] - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - targets Sequence[str]
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
- generated
Rules "ALLOWLIST" | "DENYLIST"Type - Whether you want to allow or deny access to the domains in your target list.
- target
Types List<"TLS_SNI" | "HTTP_HOST"> - The types of targets to inspect for. Valid values are
TLS_SNI
andHTTP_HOST
. - targets List<String>
- 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 domainabc.example.com
. - Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
- Explicit names. For example,
RuleGroupStatefulRule
- Action
Pulumi.
Aws Native. Network Firewall. Rule Group Stateful Rule Action 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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- Header
Pulumi.
Aws Native. Network Firewall. Inputs. Rule Group Header - The stateful inspection criteria for this rule, used to inspect traffic flows.
- Rule
Options List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Rule Option> - Additional settings for a stateful rule, provided as keywords and settings.
- Action
Rule
Group Stateful Rule Action 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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- Header
Rule
Group Header - The stateful inspection criteria for this rule, used to inspect traffic flows.
- Rule
Options []RuleGroup Rule Option - Additional settings for a stateful rule, provided as keywords and settings.
- action
Rule
Group Stateful Rule Action 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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- header
Rule
Group Header - The stateful inspection criteria for this rule, used to inspect traffic flows.
- rule
Options List<RuleGroup Rule Option> - Additional settings for a stateful rule, provided as keywords and settings.
- action
Rule
Group Stateful Rule Action 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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- header
Rule
Group Header - The stateful inspection criteria for this rule, used to inspect traffic flows.
- rule
Options RuleGroup Rule Option[] - Additional settings for a stateful rule, provided as keywords and settings.
- action
Rule
Group Stateful Rule Action 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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- header
Rule
Group Header - The stateful inspection criteria for this rule, used to inspect traffic flows.
- rule_
options Sequence[RuleGroup Rule Option] - Additional settings for a stateful rule, provided as keywords and settings.
- action "PASS" | "DROP" | "ALERT" | "REJECT"
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
. - 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 a
RST
bit contained in the TCP header flags.REJECT
is available only for TCP traffic. - 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 toDROP
.- 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 theFirewall
LoggingConfiguration
.
REJECT
isn't currently available for use with IMAP and FTP protocols.- header Property Map
- The stateful inspection criteria for this rule, used to inspect traffic flows.
- rule
Options List<Property Map> - Additional settings for a stateful rule, provided as keywords and settings.
RuleGroupStatefulRuleAction
RuleGroupStatefulRuleOptions
- Rule
Order Pulumi.Aws Native. Network Firewall. Rule Group Rule Order - 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 AWS Network Firewall Developer Guide .
- Rule
Order RuleGroup Rule Order - 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 AWS Network Firewall Developer Guide .
- rule
Order RuleGroup Rule Order - 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 AWS Network Firewall Developer Guide .
- rule
Order RuleGroup Rule Order - 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 AWS Network Firewall Developer Guide .
- rule_
order RuleGroup Rule Order - 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 AWS Network Firewall Developer Guide .
- rule
Order "DEFAULT_ACTION_ORDER" | "STRICT_ORDER" - 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 AWS Network Firewall Developer Guide .
RuleGroupStatelessRule
- Priority int
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Rule Definition - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
- Priority int
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 RuleGroup Rule Definition - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
- priority Integer
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 RuleGroup Rule Definition - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
- priority number
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 RuleGroup Rule Definition - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
- priority int
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 RuleGroup Rule Definition - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
- priority Number
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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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 Property Map - Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
RuleGroupStatelessRulesAndCustomActions
- Stateless
Rules List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Stateless Rule> - Defines the set of stateless rules for use in a stateless rule group.
- Custom
Actions List<Pulumi.Aws Native. Network Firewall. Inputs. Rule Group Custom Action> - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
- Stateless
Rules []RuleGroup Stateless Rule - Defines the set of stateless rules for use in a stateless rule group.
- Custom
Actions []RuleGroup Custom Action - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
- stateless
Rules List<RuleGroup Stateless Rule> - Defines the set of stateless rules for use in a stateless rule group.
- custom
Actions List<RuleGroup Custom Action> - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
- stateless
Rules RuleGroup Stateless Rule[] - Defines the set of stateless rules for use in a stateless rule group.
- custom
Actions RuleGroup Custom Action[] - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
- stateless_
rules Sequence[RuleGroup Stateless Rule] - Defines the set of stateless rules for use in a stateless rule group.
- custom_
actions Sequence[RuleGroup Custom Action] - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
- stateless
Rules List<Property Map> - Defines the set of stateless rules for use in a stateless rule group.
- custom
Actions List<Property Map> - 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 stateless ruleRuleGroup.RuleDefinition
Actions
specification.
RuleGroupTargetType
RuleGroupTcpFlag
RuleGroupTcpFlagField
- Flags
List<Pulumi.
Aws Native. Network Firewall. Rule Group Tcp Flag> 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 theMasks
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
List<Pulumi.
Aws Native. Network Firewall. Rule Group Tcp Flag> - The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
- Flags
[]Rule
Group Tcp Flag 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 theMasks
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
[]Rule
Group Tcp Flag - The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
- flags
List<Rule
Group Tcp Flag> 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 theMasks
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
List<Rule
Group Tcp Flag> - The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
- flags
Rule
Group Tcp Flag[] 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 theMasks
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
Rule
Group Tcp Flag[] - The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
- flags
Sequence[Rule
Group Tcp Flag] 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 theMasks
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
Sequence[Rule
Group Tcp Flag] - The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
- flags List<"FIN" | "SYN" | "RST" | "PSH" | "ACK" | "URG" | "ECE" | "CWR">
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 theMasks
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 List<"FIN" | "SYN" | "RST" | "PSH" | "ACK" | "URG" | "ECE" | "CWR">
- The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.