Package software.amazon.awscdk.services.networkfirewall

Class CfnRuleGroup.StatefulRuleProperty.Builder

java.lang.Object
software.amazon.awscdk.services.networkfirewall.CfnRuleGroup.StatefulRuleProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnRuleGroup.StatefulRuleProperty>
Enclosing interface:
CfnRuleGroup.StatefulRuleProperty
@Stability(Stable) public static final class CfnRuleGroup.StatefulRuleProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnRuleGroup.StatefulRuleProperty>
A builder for CfnRuleGroup.StatefulRuleProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • action

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty.Builder action(String action)
      Sets the value of CfnRuleGroup.StatefulRuleProperty.getAction()
      Parameters:
      action - Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. This parameter is required. 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 to DROP .

      • REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall LoggingConfiguration .

      REJECT isn't currently available for use with IMAP and FTP protocols.

      Returns:
      this

    • header

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty.Builder header(IResolvable header)
      Sets the value of CfnRuleGroup.StatefulRuleProperty.getHeader()
      Parameters:
      header - The stateful inspection criteria for this rule, used to inspect traffic flows. This parameter is required.
      Returns:
      this

    • header

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty.Builder header(CfnRuleGroup.HeaderProperty header)
      Sets the value of CfnRuleGroup.StatefulRuleProperty.getHeader()
      Parameters:
      header - The stateful inspection criteria for this rule, used to inspect traffic flows. This parameter is required.
      Returns:
      this

    • ruleOptions

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty.Builder ruleOptions(IResolvable ruleOptions)
      Sets the value of CfnRuleGroup.StatefulRuleProperty.getRuleOptions()
      Parameters:
      ruleOptions - Additional settings for a stateful rule, provided as keywords and settings. This parameter is required.
      Returns:
      this

    • ruleOptions

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty.Builder ruleOptions(List<? extends Object> ruleOptions)
      Sets the value of CfnRuleGroup.StatefulRuleProperty.getRuleOptions()
      Parameters:
      ruleOptions - Additional settings for a stateful rule, provided as keywords and settings. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnRuleGroup.StatefulRuleProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnRuleGroup.StatefulRuleProperty>
      Returns:
      a new instance of CfnRuleGroup.StatefulRuleProperty
      Throws:
      NullPointerException - if any required attribute was not provided