AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::NetworkFirewall::Model::RuleDefinition Class Reference

#include <RuleDefinition.h>

Public Member Functions

 RuleDefinition ()
 
 RuleDefinition (Aws::Utils::Json::JsonView jsonValue)
 
RuleDefinitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const MatchAttributesGetMatchAttributes () const
 
bool MatchAttributesHasBeenSet () const
 
void SetMatchAttributes (const MatchAttributes &value)
 
void SetMatchAttributes (MatchAttributes &&value)
 
RuleDefinitionWithMatchAttributes (const MatchAttributes &value)
 
RuleDefinitionWithMatchAttributes (MatchAttributes &&value)
 
const Aws::Vector< Aws::String > & GetActions () const
 
bool ActionsHasBeenSet () const
 
void SetActions (const Aws::Vector< Aws::String > &value)
 
void SetActions (Aws::Vector< Aws::String > &&value)
 
RuleDefinitionWithActions (const Aws::Vector< Aws::String > &value)
 
RuleDefinitionWithActions (Aws::Vector< Aws::String > &&value)
 
RuleDefinitionAddActions (const Aws::String &value)
 
RuleDefinitionAddActions (Aws::String &&value)
 
RuleDefinitionAddActions (const char *value)
 

Detailed Description

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 Reference

Definition at line 36 of file RuleDefinition.h.

Constructor & Destructor Documentation

◆ RuleDefinition() [1/2]

Aws::NetworkFirewall::Model::RuleDefinition::RuleDefinition ( )

◆ RuleDefinition() [2/2]

Aws::NetworkFirewall::Model::RuleDefinition::RuleDefinition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionsHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleDefinition::ActionsHasBeenSet ( ) const
inline

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”].

Definition at line 140 of file RuleDefinition.h.

◆ AddActions() [1/3]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::AddActions ( Aws::String &&  value)
inline

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”].

Definition at line 302 of file RuleDefinition.h.

◆ AddActions() [2/3]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::AddActions ( const Aws::String value)
inline

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”].

Definition at line 275 of file RuleDefinition.h.

◆ AddActions() [3/3]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::AddActions ( const char *  value)
inline

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”].

Definition at line 329 of file RuleDefinition.h.

◆ GetActions()

const Aws::Vector<Aws::String>& Aws::NetworkFirewall::Model::RuleDefinition::GetActions ( ) const
inline

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”].

Definition at line 113 of file RuleDefinition.h.

◆ GetMatchAttributes()

const MatchAttributes& Aws::NetworkFirewall::Model::RuleDefinition::GetMatchAttributes ( ) const
inline

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.

Definition at line 50 of file RuleDefinition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::NetworkFirewall::Model::RuleDefinition::Jsonize ( ) const

◆ MatchAttributesHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleDefinition::MatchAttributesHasBeenSet ( ) const
inline

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.

Definition at line 57 of file RuleDefinition.h.

◆ operator=()

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetActions() [1/2]

void Aws::NetworkFirewall::Model::RuleDefinition::SetActions ( Aws::Vector< Aws::String > &&  value)
inline

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”].

Definition at line 194 of file RuleDefinition.h.

◆ SetActions() [2/2]

void Aws::NetworkFirewall::Model::RuleDefinition::SetActions ( const Aws::Vector< Aws::String > &  value)
inline

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”].

Definition at line 167 of file RuleDefinition.h.

◆ SetMatchAttributes() [1/2]

void Aws::NetworkFirewall::Model::RuleDefinition::SetMatchAttributes ( const MatchAttributes value)
inline

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.

Definition at line 64 of file RuleDefinition.h.

◆ SetMatchAttributes() [2/2]

void Aws::NetworkFirewall::Model::RuleDefinition::SetMatchAttributes ( MatchAttributes &&  value)
inline

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.

Definition at line 71 of file RuleDefinition.h.

◆ WithActions() [1/2]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::WithActions ( Aws::Vector< Aws::String > &&  value)
inline

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”].

Definition at line 248 of file RuleDefinition.h.

◆ WithActions() [2/2]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::WithActions ( const Aws::Vector< Aws::String > &  value)
inline

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”].

Definition at line 221 of file RuleDefinition.h.

◆ WithMatchAttributes() [1/2]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::WithMatchAttributes ( const MatchAttributes value)
inline

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.

Definition at line 78 of file RuleDefinition.h.

◆ WithMatchAttributes() [2/2]

RuleDefinition& Aws::NetworkFirewall::Model::RuleDefinition::WithMatchAttributes ( MatchAttributes &&  value)
inline

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.

Definition at line 85 of file RuleDefinition.h.


The documentation for this class was generated from the following file: