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

#include <CreateRuleGroupRequest.h>

+ Inheritance diagram for Aws::NetworkFirewall::Model::CreateRuleGroupRequest:

Public Member Functions

 CreateRuleGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetRuleGroupName () const
 
bool RuleGroupNameHasBeenSet () const
 
void SetRuleGroupName (const Aws::String &value)
 
void SetRuleGroupName (Aws::String &&value)
 
void SetRuleGroupName (const char *value)
 
CreateRuleGroupRequestWithRuleGroupName (const Aws::String &value)
 
CreateRuleGroupRequestWithRuleGroupName (Aws::String &&value)
 
CreateRuleGroupRequestWithRuleGroupName (const char *value)
 
const RuleGroupGetRuleGroup () const
 
bool RuleGroupHasBeenSet () const
 
void SetRuleGroup (const RuleGroup &value)
 
void SetRuleGroup (RuleGroup &&value)
 
CreateRuleGroupRequestWithRuleGroup (const RuleGroup &value)
 
CreateRuleGroupRequestWithRuleGroup (RuleGroup &&value)
 
const Aws::StringGetRules () const
 
bool RulesHasBeenSet () const
 
void SetRules (const Aws::String &value)
 
void SetRules (Aws::String &&value)
 
void SetRules (const char *value)
 
CreateRuleGroupRequestWithRules (const Aws::String &value)
 
CreateRuleGroupRequestWithRules (Aws::String &&value)
 
CreateRuleGroupRequestWithRules (const char *value)
 
const RuleGroupTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const RuleGroupType &value)
 
void SetType (RuleGroupType &&value)
 
CreateRuleGroupRequestWithType (const RuleGroupType &value)
 
CreateRuleGroupRequestWithType (RuleGroupType &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateRuleGroupRequestWithDescription (const Aws::String &value)
 
CreateRuleGroupRequestWithDescription (Aws::String &&value)
 
CreateRuleGroupRequestWithDescription (const char *value)
 
int GetCapacity () const
 
bool CapacityHasBeenSet () const
 
void SetCapacity (int value)
 
CreateRuleGroupRequestWithCapacity (int value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateRuleGroupRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateRuleGroupRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateRuleGroupRequestAddTags (const Tag &value)
 
CreateRuleGroupRequestAddTags (Tag &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CreateRuleGroupRequestWithDryRun (bool value)
 
- Public Member Functions inherited from Aws::NetworkFirewall::NetworkFirewallRequest
virtual ~NetworkFirewallRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file CreateRuleGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateRuleGroupRequest()

Aws::NetworkFirewall::Model::CreateRuleGroupRequest::CreateRuleGroupRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::AddTags ( const Tag value)
inline

The key:value pairs to associate with the resource.

Definition at line 468 of file CreateRuleGroupRequest.h.

◆ AddTags() [2/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::AddTags ( Tag &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 473 of file CreateRuleGroupRequest.h.

◆ CapacityHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::CapacityHasBeenSet ( ) const
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

Definition at line 372 of file CreateRuleGroupRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::DescriptionHasBeenSet ( ) const
inline

A description of the rule group.

Definition at line 281 of file CreateRuleGroupRequest.h.

◆ DryRunHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::DryRunHasBeenSet ( ) const
inline

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

Definition at line 500 of file CreateRuleGroupRequest.h.

◆ GetCapacity()

int Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetCapacity ( ) const
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

Definition at line 342 of file CreateRuleGroupRequest.h.

◆ GetDescription()

const Aws::String& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetDescription ( ) const
inline

A description of the rule group.

Definition at line 276 of file CreateRuleGroupRequest.h.

◆ GetDryRun()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetDryRun ( ) const
inline

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

Definition at line 487 of file CreateRuleGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRuleGroup()

const RuleGroup& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetRuleGroup ( ) const
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 95 of file CreateRuleGroupRequest.h.

◆ GetRuleGroupName()

const Aws::String& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetRuleGroupName ( ) const
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 45 of file CreateRuleGroupRequest.h.

◆ GetRules()

const Aws::String& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetRules ( ) const
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 143 of file CreateRuleGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateRuleGroupRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetTags ( ) const
inline

The key:value pairs to associate with the resource.

Definition at line 438 of file CreateRuleGroupRequest.h.

◆ GetType()

const RuleGroupType& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::GetType ( ) const
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 235 of file CreateRuleGroupRequest.h.

◆ RuleGroupHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::RuleGroupHasBeenSet ( ) const
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 102 of file CreateRuleGroupRequest.h.

◆ RuleGroupNameHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::RuleGroupNameHasBeenSet ( ) const
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 51 of file CreateRuleGroupRequest.h.

◆ RulesHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::RulesHasBeenSet ( ) const
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 155 of file CreateRuleGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapacity()

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetCapacity ( int  value)
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

Definition at line 402 of file CreateRuleGroupRequest.h.

◆ SetDescription() [1/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetDescription ( Aws::String &&  value)
inline

A description of the rule group.

Definition at line 291 of file CreateRuleGroupRequest.h.

◆ SetDescription() [2/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetDescription ( const Aws::String value)
inline

A description of the rule group.

Definition at line 286 of file CreateRuleGroupRequest.h.

◆ SetDescription() [3/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetDescription ( const char *  value)
inline

A description of the rule group.

Definition at line 296 of file CreateRuleGroupRequest.h.

◆ SetDryRun()

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetDryRun ( bool  value)
inline

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

Definition at line 513 of file CreateRuleGroupRequest.h.

◆ SetRuleGroup() [1/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRuleGroup ( const RuleGroup value)
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 109 of file CreateRuleGroupRequest.h.

◆ SetRuleGroup() [2/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRuleGroup ( RuleGroup &&  value)
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 116 of file CreateRuleGroupRequest.h.

◆ SetRuleGroupName() [1/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRuleGroupName ( Aws::String &&  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 63 of file CreateRuleGroupRequest.h.

◆ SetRuleGroupName() [2/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRuleGroupName ( const Aws::String value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 57 of file CreateRuleGroupRequest.h.

◆ SetRuleGroupName() [3/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRuleGroupName ( const char *  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 69 of file CreateRuleGroupRequest.h.

◆ SetRules() [1/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRules ( Aws::String &&  value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 179 of file CreateRuleGroupRequest.h.

◆ SetRules() [2/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRules ( const Aws::String value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 167 of file CreateRuleGroupRequest.h.

◆ SetRules() [3/3]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetRules ( const char *  value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 191 of file CreateRuleGroupRequest.h.

◆ SetTags() [1/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 453 of file CreateRuleGroupRequest.h.

◆ SetTags() [2/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The key:value pairs to associate with the resource.

Definition at line 448 of file CreateRuleGroupRequest.h.

◆ SetType() [1/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetType ( const RuleGroupType value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 249 of file CreateRuleGroupRequest.h.

◆ SetType() [2/2]

void Aws::NetworkFirewall::Model::CreateRuleGroupRequest::SetType ( RuleGroupType &&  value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 256 of file CreateRuleGroupRequest.h.

◆ TagsHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::TagsHasBeenSet ( ) const
inline

The key:value pairs to associate with the resource.

Definition at line 443 of file CreateRuleGroupRequest.h.

◆ TypeHasBeenSet()

bool Aws::NetworkFirewall::Model::CreateRuleGroupRequest::TypeHasBeenSet ( ) const
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 242 of file CreateRuleGroupRequest.h.

◆ WithCapacity()

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithCapacity ( int  value)
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

Definition at line 432 of file CreateRuleGroupRequest.h.

◆ WithDescription() [1/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithDescription ( Aws::String &&  value)
inline

A description of the rule group.

Definition at line 306 of file CreateRuleGroupRequest.h.

◆ WithDescription() [2/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithDescription ( const Aws::String value)
inline

A description of the rule group.

Definition at line 301 of file CreateRuleGroupRequest.h.

◆ WithDescription() [3/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithDescription ( const char *  value)
inline

A description of the rule group.

Definition at line 311 of file CreateRuleGroupRequest.h.

◆ WithDryRun()

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithDryRun ( bool  value)
inline

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

Definition at line 526 of file CreateRuleGroupRequest.h.

◆ WithRuleGroup() [1/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRuleGroup ( const RuleGroup value)
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 123 of file CreateRuleGroupRequest.h.

◆ WithRuleGroup() [2/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRuleGroup ( RuleGroup &&  value)
inline

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Definition at line 130 of file CreateRuleGroupRequest.h.

◆ WithRuleGroupName() [1/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRuleGroupName ( Aws::String &&  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 81 of file CreateRuleGroupRequest.h.

◆ WithRuleGroupName() [2/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRuleGroupName ( const Aws::String value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 75 of file CreateRuleGroupRequest.h.

◆ WithRuleGroupName() [3/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRuleGroupName ( const char *  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 87 of file CreateRuleGroupRequest.h.

◆ WithRules() [1/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRules ( Aws::String &&  value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 215 of file CreateRuleGroupRequest.h.

◆ WithRules() [2/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRules ( const Aws::String value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 203 of file CreateRuleGroupRequest.h.

◆ WithRules() [3/3]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithRules ( const char *  value)
inline

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Definition at line 227 of file CreateRuleGroupRequest.h.

◆ WithTags() [1/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 463 of file CreateRuleGroupRequest.h.

◆ WithTags() [2/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The key:value pairs to associate with the resource.

Definition at line 458 of file CreateRuleGroupRequest.h.

◆ WithType() [1/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithType ( const RuleGroupType value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 263 of file CreateRuleGroupRequest.h.

◆ WithType() [2/2]

CreateRuleGroupRequest& Aws::NetworkFirewall::Model::CreateRuleGroupRequest::WithType ( RuleGroupType &&  value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 270 of file CreateRuleGroupRequest.h.


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