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

#include <UpdateRuleGroupRequest.h>

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

Public Member Functions

 UpdateRuleGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUpdateToken () const
 
bool UpdateTokenHasBeenSet () const
 
void SetUpdateToken (const Aws::String &value)
 
void SetUpdateToken (Aws::String &&value)
 
void SetUpdateToken (const char *value)
 
UpdateRuleGroupRequestWithUpdateToken (const Aws::String &value)
 
UpdateRuleGroupRequestWithUpdateToken (Aws::String &&value)
 
UpdateRuleGroupRequestWithUpdateToken (const char *value)
 
const Aws::StringGetRuleGroupArn () const
 
bool RuleGroupArnHasBeenSet () const
 
void SetRuleGroupArn (const Aws::String &value)
 
void SetRuleGroupArn (Aws::String &&value)
 
void SetRuleGroupArn (const char *value)
 
UpdateRuleGroupRequestWithRuleGroupArn (const Aws::String &value)
 
UpdateRuleGroupRequestWithRuleGroupArn (Aws::String &&value)
 
UpdateRuleGroupRequestWithRuleGroupArn (const char *value)
 
const Aws::StringGetRuleGroupName () const
 
bool RuleGroupNameHasBeenSet () const
 
void SetRuleGroupName (const Aws::String &value)
 
void SetRuleGroupName (Aws::String &&value)
 
void SetRuleGroupName (const char *value)
 
UpdateRuleGroupRequestWithRuleGroupName (const Aws::String &value)
 
UpdateRuleGroupRequestWithRuleGroupName (Aws::String &&value)
 
UpdateRuleGroupRequestWithRuleGroupName (const char *value)
 
const RuleGroupGetRuleGroup () const
 
bool RuleGroupHasBeenSet () const
 
void SetRuleGroup (const RuleGroup &value)
 
void SetRuleGroup (RuleGroup &&value)
 
UpdateRuleGroupRequestWithRuleGroup (const RuleGroup &value)
 
UpdateRuleGroupRequestWithRuleGroup (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)
 
UpdateRuleGroupRequestWithRules (const Aws::String &value)
 
UpdateRuleGroupRequestWithRules (Aws::String &&value)
 
UpdateRuleGroupRequestWithRules (const char *value)
 
const RuleGroupTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const RuleGroupType &value)
 
void SetType (RuleGroupType &&value)
 
UpdateRuleGroupRequestWithType (const RuleGroupType &value)
 
UpdateRuleGroupRequestWithType (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)
 
UpdateRuleGroupRequestWithDescription (const Aws::String &value)
 
UpdateRuleGroupRequestWithDescription (Aws::String &&value)
 
UpdateRuleGroupRequestWithDescription (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
UpdateRuleGroupRequestWithDryRun (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 23 of file UpdateRuleGroupRequest.h.

Constructor & Destructor Documentation

◆ UpdateRuleGroupRequest()

Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::UpdateRuleGroupRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

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

A description of the rule group.

Definition at line 447 of file UpdateRuleGroupRequest.h.

◆ DryRunHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 504 of file UpdateRuleGroupRequest.h.

◆ GetDescription()

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

A description of the rule group.

Definition at line 442 of file UpdateRuleGroupRequest.h.

◆ GetDryRun()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 491 of file UpdateRuleGroupRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetRuleGroup()

const RuleGroup& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 255 of file UpdateRuleGroupRequest.h.

◆ GetRuleGroupArn()

const Aws::String& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::GetRuleGroupArn ( ) const
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 148 of file UpdateRuleGroupRequest.h.

◆ GetRuleGroupName()

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

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

You must specify the ARN or the name, and you can specify both.

Definition at line 198 of file UpdateRuleGroupRequest.h.

◆ GetRules()

const Aws::String& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 303 of file UpdateRuleGroupRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file UpdateRuleGroupRequest.h.

◆ GetType()

const RuleGroupType& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 396 of file UpdateRuleGroupRequest.h.

◆ GetUpdateToken()

const Aws::String& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::GetUpdateToken ( ) const
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 50 of file UpdateRuleGroupRequest.h.

◆ RuleGroupArnHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::RuleGroupArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 154 of file UpdateRuleGroupRequest.h.

◆ RuleGroupHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 262 of file UpdateRuleGroupRequest.h.

◆ RuleGroupNameHasBeenSet()

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

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

You must specify the ARN or the name, and you can specify both.

Definition at line 205 of file UpdateRuleGroupRequest.h.

◆ RulesHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 315 of file UpdateRuleGroupRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

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

A description of the rule group.

Definition at line 457 of file UpdateRuleGroupRequest.h.

◆ SetDescription() [2/3]

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

A description of the rule group.

Definition at line 452 of file UpdateRuleGroupRequest.h.

◆ SetDescription() [3/3]

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

A description of the rule group.

Definition at line 462 of file UpdateRuleGroupRequest.h.

◆ SetDryRun()

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 517 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroup() [1/2]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 269 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroup() [2/2]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 276 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupArn() [1/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetRuleGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 166 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupArn() [2/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetRuleGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 160 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupArn() [3/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetRuleGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 172 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupName() [1/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 219 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupName() [2/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 212 of file UpdateRuleGroupRequest.h.

◆ SetRuleGroupName() [3/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 226 of file UpdateRuleGroupRequest.h.

◆ SetRules() [1/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 339 of file UpdateRuleGroupRequest.h.

◆ SetRules() [2/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 327 of file UpdateRuleGroupRequest.h.

◆ SetRules() [3/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 351 of file UpdateRuleGroupRequest.h.

◆ SetType() [1/2]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 412 of file UpdateRuleGroupRequest.h.

◆ SetType() [2/2]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 420 of file UpdateRuleGroupRequest.h.

◆ SetUpdateToken() [1/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetUpdateToken ( Aws::String &&  value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 89 of file UpdateRuleGroupRequest.h.

◆ SetUpdateToken() [2/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetUpdateToken ( const Aws::String value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 76 of file UpdateRuleGroupRequest.h.

◆ SetUpdateToken() [3/3]

void Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::SetUpdateToken ( const char *  value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 102 of file UpdateRuleGroupRequest.h.

◆ TypeHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 404 of file UpdateRuleGroupRequest.h.

◆ UpdateTokenHasBeenSet()

bool Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::UpdateTokenHasBeenSet ( ) const
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 63 of file UpdateRuleGroupRequest.h.

◆ WithDescription() [1/3]

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

A description of the rule group.

Definition at line 472 of file UpdateRuleGroupRequest.h.

◆ WithDescription() [2/3]

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

A description of the rule group.

Definition at line 467 of file UpdateRuleGroupRequest.h.

◆ WithDescription() [3/3]

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

A description of the rule group.

Definition at line 477 of file UpdateRuleGroupRequest.h.

◆ WithDryRun()

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 530 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroup() [1/2]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 283 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroup() [2/2]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 290 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupArn() [1/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithRuleGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 184 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupArn() [2/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithRuleGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 178 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupArn() [3/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithRuleGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Definition at line 190 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupName() [1/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 240 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupName() [2/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 233 of file UpdateRuleGroupRequest.h.

◆ WithRuleGroupName() [3/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

You must specify the ARN or the name, and you can specify both.

Definition at line 247 of file UpdateRuleGroupRequest.h.

◆ WithRules() [1/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 375 of file UpdateRuleGroupRequest.h.

◆ WithRules() [2/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 363 of file UpdateRuleGroupRequest.h.

◆ WithRules() [3/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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 387 of file UpdateRuleGroupRequest.h.

◆ WithType() [1/2]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 428 of file UpdateRuleGroupRequest.h.

◆ WithType() [2/2]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::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.

This setting is required for requests that do not include the RuleGroupARN.

Definition at line 436 of file UpdateRuleGroupRequest.h.

◆ WithUpdateToken() [1/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithUpdateToken ( Aws::String &&  value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 128 of file UpdateRuleGroupRequest.h.

◆ WithUpdateToken() [2/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithUpdateToken ( const Aws::String value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 115 of file UpdateRuleGroupRequest.h.

◆ WithUpdateToken() [3/3]

UpdateRuleGroupRequest& Aws::NetworkFirewall::Model::UpdateRuleGroupRequest::WithUpdateToken ( const char *  value)
inline

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Definition at line 141 of file UpdateRuleGroupRequest.h.


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