You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WAFRegional::Types::UpdateWebACLRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb

Overview

Note:

When making an API call, you may pass UpdateWebACLRequest data as a hash:

{
  web_acl_id: "ResourceId", # required
  change_token: "ChangeToken", # required
  updates: [
    {
      action: "INSERT", # required, accepts INSERT, DELETE
      activated_rule: { # required
        priority: 1, # required
        rule_id: "ResourceId", # required
        action: { # required
          type: "BLOCK", # required, accepts BLOCK, ALLOW, COUNT
        },
        type: "REGULAR", # accepts REGULAR, RATE_BASED
      },
    },
  ],
  default_action: {
    type: "BLOCK", # required, accepts BLOCK, ALLOW, COUNT
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#change_tokenString

The value returned by the most recent call to GetChangeToken.

Returns:

  • (String)


4842
4843
4844
4845
4846
4847
4848
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4842

class UpdateWebACLRequest < Struct.new(
  :web_acl_id,
  :change_token,
  :updates,
  :default_action)
  include Aws::Structure
end

#default_actionTypes::WafAction

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

Returns:



4842
4843
4844
4845
4846
4847
4848
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4842

class UpdateWebACLRequest < Struct.new(
  :web_acl_id,
  :change_token,
  :updates,
  :default_action)
  include Aws::Structure
end

#updatesArray<Types::WebACLUpdate>

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

  • WebACLUpdate: Contains Action and ActivatedRule

  • ActivatedRule: Contains Action, Priority, RuleId, and Type

  • WafAction: Contains Type

Returns:



4842
4843
4844
4845
4846
4847
4848
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4842

class UpdateWebACLRequest < Struct.new(
  :web_acl_id,
  :change_token,
  :updates,
  :default_action)
  include Aws::Structure
end

#web_acl_idString

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

Returns:

  • (String)


4842
4843
4844
4845
4846
4847
4848
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4842

class UpdateWebACLRequest < Struct.new(
  :web_acl_id,
  :change_token,
  :updates,
  :default_action)
  include Aws::Structure
end