Class: Aws::WAFV2::Types::UpdateRuleGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_response_bodies ⇒ Hash<String,Types::CustomResponseBody>

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 rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see

Customizing web requests and responses in WAF][1

in the *WAF

Developer Guide*.

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

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html [2]: docs.aws.amazon.com/waf/latest/developerguide/limits.html

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the rule group that helps with identification.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#lock_token ⇒ String

A token used for optimistic locking. 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`. 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.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rule group. You cannot change the name of a rule group after you create it.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::Rule>

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

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

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.

Returns:

  • (String) 


9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_config ⇒ Types::VisibilityConfig

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

Returns:



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'lib/aws-sdk-wafv2/types.rb', line 9071

class UpdateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :id,
  :description,
  :rules,
  :visibility_config,
  :lock_token,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end