AWS SDK for C++  1.9.17
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::UpdateWebACLRequest Class Reference

#include <UpdateWebACLRequest.h>

+ Inheritance diagram for Aws::WAFV2::Model::UpdateWebACLRequest:

Public Member Functions

 UpdateWebACLRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateWebACLRequestWithName (const Aws::String &value)
 
UpdateWebACLRequestWithName (Aws::String &&value)
 
UpdateWebACLRequestWithName (const char *value)
 
const ScopeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Scope &value)
 
void SetScope (Scope &&value)
 
UpdateWebACLRequestWithScope (const Scope &value)
 
UpdateWebACLRequestWithScope (Scope &&value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
UpdateWebACLRequestWithId (const Aws::String &value)
 
UpdateWebACLRequestWithId (Aws::String &&value)
 
UpdateWebACLRequestWithId (const char *value)
 
const DefaultActionGetDefaultAction () const
 
bool DefaultActionHasBeenSet () const
 
void SetDefaultAction (const DefaultAction &value)
 
void SetDefaultAction (DefaultAction &&value)
 
UpdateWebACLRequestWithDefaultAction (const DefaultAction &value)
 
UpdateWebACLRequestWithDefaultAction (DefaultAction &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateWebACLRequestWithDescription (const Aws::String &value)
 
UpdateWebACLRequestWithDescription (Aws::String &&value)
 
UpdateWebACLRequestWithDescription (const char *value)
 
const Aws::Vector< Rule > & GetRules () const
 
bool RulesHasBeenSet () const
 
void SetRules (const Aws::Vector< Rule > &value)
 
void SetRules (Aws::Vector< Rule > &&value)
 
UpdateWebACLRequestWithRules (const Aws::Vector< Rule > &value)
 
UpdateWebACLRequestWithRules (Aws::Vector< Rule > &&value)
 
UpdateWebACLRequestAddRules (const Rule &value)
 
UpdateWebACLRequestAddRules (Rule &&value)
 
const VisibilityConfigGetVisibilityConfig () const
 
bool VisibilityConfigHasBeenSet () const
 
void SetVisibilityConfig (const VisibilityConfig &value)
 
void SetVisibilityConfig (VisibilityConfig &&value)
 
UpdateWebACLRequestWithVisibilityConfig (const VisibilityConfig &value)
 
UpdateWebACLRequestWithVisibilityConfig (VisibilityConfig &&value)
 
const Aws::StringGetLockToken () const
 
bool LockTokenHasBeenSet () const
 
void SetLockToken (const Aws::String &value)
 
void SetLockToken (Aws::String &&value)
 
void SetLockToken (const char *value)
 
UpdateWebACLRequestWithLockToken (const Aws::String &value)
 
UpdateWebACLRequestWithLockToken (Aws::String &&value)
 
UpdateWebACLRequestWithLockToken (const char *value)
 
const Aws::Map< Aws::String, CustomResponseBody > & GetCustomResponseBodies () const
 
bool CustomResponseBodiesHasBeenSet () const
 
void SetCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
void SetCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
UpdateWebACLRequestWithCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
UpdateWebACLRequestWithCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
UpdateWebACLRequestAddCustomResponseBodies (const Aws::String &key, const CustomResponseBody &value)
 
UpdateWebACLRequestAddCustomResponseBodies (Aws::String &&key, const CustomResponseBody &value)
 
UpdateWebACLRequestAddCustomResponseBodies (const Aws::String &key, CustomResponseBody &&value)
 
UpdateWebACLRequestAddCustomResponseBodies (Aws::String &&key, CustomResponseBody &&value)
 
UpdateWebACLRequestAddCustomResponseBodies (const char *key, CustomResponseBody &&value)
 
UpdateWebACLRequestAddCustomResponseBodies (const char *key, const CustomResponseBody &value)
 
- Public Member Functions inherited from Aws::WAFV2::WAFV2Request
virtual ~WAFV2Request ()
 
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 28 of file UpdateWebACLRequest.h.

Constructor & Destructor Documentation

◆ UpdateWebACLRequest()

Aws::WAFV2::Model::UpdateWebACLRequest::UpdateWebACLRequest ( )

Member Function Documentation

◆ AddCustomResponseBodies() [1/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( Aws::String &&  key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 636 of file UpdateWebACLRequest.h.

◆ AddCustomResponseBodies() [2/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( Aws::String &&  key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 672 of file UpdateWebACLRequest.h.

◆ AddCustomResponseBodies() [3/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( const Aws::String key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 618 of file UpdateWebACLRequest.h.

◆ AddCustomResponseBodies() [4/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( const Aws::String key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 654 of file UpdateWebACLRequest.h.

◆ AddCustomResponseBodies() [5/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( const char *  key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 708 of file UpdateWebACLRequest.h.

◆ AddCustomResponseBodies() [6/6]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddCustomResponseBodies ( const char *  key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 690 of file UpdateWebACLRequest.h.

◆ AddRules() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddRules ( const Rule value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 349 of file UpdateWebACLRequest.h.

◆ AddRules() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::AddRules ( Rule &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 357 of file UpdateWebACLRequest.h.

◆ CustomResponseBodiesHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::CustomResponseBodiesHasBeenSet ( ) const
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 528 of file UpdateWebACLRequest.h.

◆ DefaultActionHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::DefaultActionHasBeenSet ( ) const
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 227 of file UpdateWebACLRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::DescriptionHasBeenSet ( ) const
inline

A description of the Web ACL that helps with identification.

Definition at line 262 of file UpdateWebACLRequest.h.

◆ GetCustomResponseBodies()

const Aws::Map<Aws::String, CustomResponseBody>& Aws::WAFV2::Model::UpdateWebACLRequest::GetCustomResponseBodies ( ) const
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 510 of file UpdateWebACLRequest.h.

◆ GetDefaultAction()

const DefaultAction& Aws::WAFV2::Model::UpdateWebACLRequest::GetDefaultAction ( ) const
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 221 of file UpdateWebACLRequest.h.

◆ GetDescription()

const Aws::String& Aws::WAFV2::Model::UpdateWebACLRequest::GetDescription ( ) const
inline

A description of the Web ACL that helps with identification.

Definition at line 257 of file UpdateWebACLRequest.h.

◆ GetId()

const Aws::String& Aws::WAFV2::Model::UpdateWebACLRequest::GetId ( ) const
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 165 of file UpdateWebACLRequest.h.

◆ GetLockToken()

const Aws::String& Aws::WAFV2::Model::UpdateWebACLRequest::GetLockToken ( ) const
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 407 of file UpdateWebACLRequest.h.

◆ GetName()

const Aws::String& Aws::WAFV2::Model::UpdateWebACLRequest::GetName ( ) const
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 48 of file UpdateWebACLRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WAFV2::Model::UpdateWebACLRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WAFV2::WAFV2Request.

◆ GetRules()

const Aws::Vector<Rule>& Aws::WAFV2::Model::UpdateWebACLRequest::GetRules ( ) const
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 301 of file UpdateWebACLRequest.h.

◆ GetScope()

const Scope& Aws::WAFV2::Model::UpdateWebACLRequest::GetScope ( ) const
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 102 of file UpdateWebACLRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::WAFV2::Model::UpdateWebACLRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateWebACLRequest.h.

◆ GetVisibilityConfig()

const VisibilityConfig& Aws::WAFV2::Model::UpdateWebACLRequest::GetVisibilityConfig ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 364 of file UpdateWebACLRequest.h.

◆ IdHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::IdHasBeenSet ( ) const
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 172 of file UpdateWebACLRequest.h.

◆ LockTokenHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::LockTokenHasBeenSet ( ) const
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 419 of file UpdateWebACLRequest.h.

◆ NameHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::NameHasBeenSet ( ) const
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 54 of file UpdateWebACLRequest.h.

◆ RulesHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::RulesHasBeenSet ( ) const
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 309 of file UpdateWebACLRequest.h.

◆ ScopeHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::ScopeHasBeenSet ( ) const
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 113 of file UpdateWebACLRequest.h.

◆ SerializePayload()

Aws::String Aws::WAFV2::Model::UpdateWebACLRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomResponseBodies() [1/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 564 of file UpdateWebACLRequest.h.

◆ SetCustomResponseBodies() [2/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 546 of file UpdateWebACLRequest.h.

◆ SetDefaultAction() [1/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetDefaultAction ( const DefaultAction value)
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 233 of file UpdateWebACLRequest.h.

◆ SetDefaultAction() [2/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetDefaultAction ( DefaultAction &&  value)
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 239 of file UpdateWebACLRequest.h.

◆ SetDescription() [1/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetDescription ( Aws::String &&  value)
inline

A description of the Web ACL that helps with identification.

Definition at line 272 of file UpdateWebACLRequest.h.

◆ SetDescription() [2/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetDescription ( const Aws::String value)
inline

A description of the Web ACL that helps with identification.

Definition at line 267 of file UpdateWebACLRequest.h.

◆ SetDescription() [3/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetDescription ( const char *  value)
inline

A description of the Web ACL that helps with identification.

Definition at line 277 of file UpdateWebACLRequest.h.

◆ SetId() [1/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetId ( Aws::String &&  value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 186 of file UpdateWebACLRequest.h.

◆ SetId() [2/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetId ( const Aws::String value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 179 of file UpdateWebACLRequest.h.

◆ SetId() [3/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetId ( const char *  value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 193 of file UpdateWebACLRequest.h.

◆ SetLockToken() [1/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetLockToken ( Aws::String &&  value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 443 of file UpdateWebACLRequest.h.

◆ SetLockToken() [2/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetLockToken ( const Aws::String value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 431 of file UpdateWebACLRequest.h.

◆ SetLockToken() [3/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetLockToken ( const char *  value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 455 of file UpdateWebACLRequest.h.

◆ SetName() [1/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetName ( Aws::String &&  value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 66 of file UpdateWebACLRequest.h.

◆ SetName() [2/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetName ( const Aws::String value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 60 of file UpdateWebACLRequest.h.

◆ SetName() [3/3]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetName ( const char *  value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 72 of file UpdateWebACLRequest.h.

◆ SetRules() [1/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetRules ( Aws::Vector< Rule > &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 325 of file UpdateWebACLRequest.h.

◆ SetRules() [2/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetRules ( const Aws::Vector< Rule > &  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 317 of file UpdateWebACLRequest.h.

◆ SetScope() [1/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetScope ( const Scope value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 124 of file UpdateWebACLRequest.h.

◆ SetScope() [2/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetScope ( Scope &&  value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 135 of file UpdateWebACLRequest.h.

◆ SetVisibilityConfig() [1/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 376 of file UpdateWebACLRequest.h.

◆ SetVisibilityConfig() [2/2]

void Aws::WAFV2::Model::UpdateWebACLRequest::SetVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 382 of file UpdateWebACLRequest.h.

◆ VisibilityConfigHasBeenSet()

bool Aws::WAFV2::Model::UpdateWebACLRequest::VisibilityConfigHasBeenSet ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 370 of file UpdateWebACLRequest.h.

◆ WithCustomResponseBodies() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 600 of file UpdateWebACLRequest.h.

◆ WithCustomResponseBodies() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 582 of file UpdateWebACLRequest.h.

◆ WithDefaultAction() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithDefaultAction ( const DefaultAction value)
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 245 of file UpdateWebACLRequest.h.

◆ WithDefaultAction() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithDefaultAction ( DefaultAction &&  value)
inline

The action to perform if none of the Rules contained in the WebACL match.

Definition at line 251 of file UpdateWebACLRequest.h.

◆ WithDescription() [1/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithDescription ( Aws::String &&  value)
inline

A description of the Web ACL that helps with identification.

Definition at line 287 of file UpdateWebACLRequest.h.

◆ WithDescription() [2/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithDescription ( const Aws::String value)
inline

A description of the Web ACL that helps with identification.

Definition at line 282 of file UpdateWebACLRequest.h.

◆ WithDescription() [3/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithDescription ( const char *  value)
inline

A description of the Web ACL that helps with identification.

Definition at line 292 of file UpdateWebACLRequest.h.

◆ WithId() [1/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithId ( Aws::String &&  value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 207 of file UpdateWebACLRequest.h.

◆ WithId() [2/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithId ( const Aws::String value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 200 of file UpdateWebACLRequest.h.

◆ WithId() [3/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithId ( const char *  value)
inline

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 214 of file UpdateWebACLRequest.h.

◆ WithLockToken() [1/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithLockToken ( Aws::String &&  value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 479 of file UpdateWebACLRequest.h.

◆ WithLockToken() [2/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithLockToken ( const Aws::String value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 467 of file UpdateWebACLRequest.h.

◆ WithLockToken() [3/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithLockToken ( const char *  value)
inline

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Definition at line 491 of file UpdateWebACLRequest.h.

◆ WithName() [1/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithName ( Aws::String &&  value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 84 of file UpdateWebACLRequest.h.

◆ WithName() [2/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithName ( const Aws::String value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 78 of file UpdateWebACLRequest.h.

◆ WithName() [3/3]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithName ( const char *  value)
inline

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Definition at line 90 of file UpdateWebACLRequest.h.

◆ WithRules() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithRules ( Aws::Vector< Rule > &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 341 of file UpdateWebACLRequest.h.

◆ WithRules() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithRules ( const Aws::Vector< Rule > &  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 333 of file UpdateWebACLRequest.h.

◆ WithScope() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithScope ( const Scope value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 146 of file UpdateWebACLRequest.h.

◆ WithScope() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithScope ( Scope &&  value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 157 of file UpdateWebACLRequest.h.

◆ WithVisibilityConfig() [1/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 388 of file UpdateWebACLRequest.h.

◆ WithVisibilityConfig() [2/2]

UpdateWebACLRequest& Aws::WAFV2::Model::UpdateWebACLRequest::WithVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 394 of file UpdateWebACLRequest.h.


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