RuleDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.model.RuleDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleDefinition()

Constructors
Constructor and Description
`RuleDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getActions()` The actions to take on a packet that matches one of the stateless rule definition's match attributes.
`MatchAttributes`	`getMatchAttributes()` Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActions(Collection<String> actions)` The actions to take on a packet that matches one of the stateless rule definition's match attributes.
`void`	`setMatchAttributes(MatchAttributes matchAttributes)` Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.
`String`	`toString()` Returns a string representation of this object.
`RuleDefinition`	`withActions(Collection<String> actions)` The actions to take on a packet that matches one of the stateless rule definition's match attributes.
`RuleDefinition`	`withActions(String... actions)` The actions to take on a packet that matches one of the stateless rule definition's match attributes.
`RuleDefinition`	`withMatchAttributes(MatchAttributes matchAttributes)` Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RuleDefinition
```
public RuleDefinition()
```
- Method Detail
  - setMatchAttributes
```
public void setMatchAttributes(MatchAttributes matchAttributes)
```
    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.
    
    Parameters:
    
    matchAttributes - 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.
  - getMatchAttributes
```
public MatchAttributes getMatchAttributes()
```
    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.
    
    Returns:
    
    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.
  - withMatchAttributes
```
public RuleDefinition withMatchAttributes(MatchAttributes matchAttributes)
```
    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.
    
    Parameters:
    
    matchAttributes - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<String> getActions()
```
    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    - aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    - aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    - aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”] .
    Returns:
    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    
    aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    
    aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    
    aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
  - setActions
```
public void setActions(Collection<String> actions)
```
    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    - aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    - aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    - aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”] .
    Parameters:
    actions - The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    
    aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    
    aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    
    aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
  - withActions
```
public RuleDefinition withActions(String... actions)
```
    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    - aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    - aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    - aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”] .
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    Parameters:
    actions - The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    
    aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    
    aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    
    aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public RuleDefinition withActions(Collection<String> actions)
```
    The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    - aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    - aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    - aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”] .
    Parameters:
    actions - The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
    
    Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
    
    For every rule, you must specify exactly one of the following standard actions.
    
    aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
    
    aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
    
    aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
    
    Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
    
    To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RuleDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RuleDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleDefinition

Method Detail

setMatchAttributes

getMatchAttributes

withMatchAttributes

getActions

setActions

withActions

withActions

toString

equals

hashCode

clone

marshall